Skip to content

JoeStone13/deved-platform

Repository files navigation

Vonage Developer Education Content Platform

The source and content for the Vonage Developer Education Content Platform, based on Nuxt.js
  • Zero configuration local builds (without search)
  • nuxt/content for loading of markdown and json files
  • Algolia search with vue-instantsearch and algoliasearch (requires some configuration)
  • RSS and author RSS feeds using nuxtjs/feeds
  • DISQUS comments on post pages using vue-disqus
  • Netlify CMS for content management

Table of Contents

Installation

Please checkout the local setup guide for more information on installation and usage.

Contributing

Please read our Contributing Guide and Code of Conduct before making a pull request.

Components

Components can be included in posts but should not be expected to appear as part of RSS based exports or readers.

Check out the Nuxt.js @nuxt/content module documentation for writing content with Vue components.

Writing Style

Taken from our developer education writing styleguide, we've included our writing style guide to help with contributing content.

Tools

Blog Posts

Create a new blog post using the CLI.

npm run blog

# node bin/blog

# ? What's the title for this post? <max 70 chars> Your post title goes here!
# ? What's the description? <max 240 chars> A post description that shouod be less than 240 characters
# ? What's the category? Tutorial
# ? Who's the author? Luke Oliff
# ? Enable comments? Yes
# ? By spotlight author? No
# ✔ Saved demo file to content/blog/your-post-title-goes-here.md...    

Legacy Content Importer

Imports content from a WordPress WP API instance.

WP_USERNAME={username} WP_PASSWORD={password} node bin/exporter

Shouldn't be used unless importing content from WordPress.

Legacy Author Importer

Imports authors from a WordPress WP API instance.

WP_USERNAME={username} WP_PASSWORD={password} node bin/authors

Shouldn't be used unless importing authors from WordPress.

License

The content of this project itself is licensed under the Creative Commons Attribution 3.0 Unported license, and the underlying source code used to format and display that content is licensed under the MIT license.

About

Nuxt.js for the new Vonage Developer Education site.

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published