Skip to content

📖 Gatsby theme for api documentation

License

Notifications You must be signed in to change notification settings

spotxyz/greenboard

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

91 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Greenboard

Create beautiful api documentation with gatsby and greenboard

Installation

Setup your folder and install gatsby, react and react-dom

mkdir my-docs
cd my-docs
yarn init

yarn add gatsby react react-dom

Install greenboard

yarn add gatsby-greenboard

Then add gatsby-greenboard to your gatsby-config.js.

module.exports = {
  plugins: [
    {
      resolve: "gatsby-greenboard",
      options: {},
    },
  ],
}

That's it, you can now run your gatsby site using

yarn gatsby develop

Build the production files

yarn gatsby build

About

📖 Gatsby theme for api documentation

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 51.7%
  • SCSS 40.6%
  • CSS 7.7%