Skip to content
forked from mrcrmn/docc

A starter documentation theme for Gridsome. Featuring instant search, great navigation and a dark mode!

License

Notifications You must be signed in to change notification settings

randrewsimcdi/docc

 
 

Repository files navigation

Logo

Pharos resource center built with a starter documentation theme for Gridsome.

Installation

Ensure you have Gridsome installed...see here Gridsome How To Install

Once you have the Gridsome CLI installed, simply run:

gridsome create your-project https://github.com/randrewsimcdi/docc

Documentation

Documentation can be found here.

Managing Content

  • Currently, using [Netlify CMS] (https://www.netlifycms.org/)
  • Log in by getting access to the GitHub repo then going to OurDomainName.com/admin
  • Publishing a documentation article requires the following fields...see below as reference
title: "Creating Users"
description: "Pharos CRM: Creating Users"
url: crm-creating-users
sidebar: docs
date: 2020-09-24T12:10:53.448Z

Optional fields to have next page or prev page buttons

next: /docs/next-doc
prev: /docs/prev-doc

Note: the sidebar field must contain docs

Publishing Content

Once you click publish, the article gets pushed to Github, then deployed automatically by Netlify.

Add Article to Menu Bar

  • Edit the file gridsome.config.js
  • Add your article url to the items
  • Save file and commit to Github with the messsage menu update: article name, article name, article name
  • Wait 1-3 minutes for site to be live
// gridsome.config.js
module.exports = {
  // ...
  settings: {
    sidebar: [
      name: 'docs',
      sections: [
        {
          title: 'Getting Started',
          items: [
            '/docs/',
            '/docs/installation/',
            '/docs/writing-content/',
          ]
        },
      ]
    ]
  },
  // ...
}

About

A starter documentation theme for Gridsome. Featuring instant search, great navigation and a dark mode!

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Vue 92.6%
  • JavaScript 7.0%
  • HTML 0.4%