docbrown/docs/contributing.md
Andrew Brown 30dcb23169 #2507 - refactor GitDocs documentation (#2595)
* #2507 - refactor GitDocs documentation

* #2507 - fix grammar and spelling errors
2019-04-29 10:08:22 -04:00

1 KiB

title
Contributing to Docs

Contributing to Docs

The documentation you are reading is powered by GitDocs.

Where The Docs Are Located

This documentation is located in the DEV.to codebase within the /docs directory.

The docs are a collection of Markdown files that also utilize FrontMatter.

For more information on how to use GitDocs read the GitDocs guide

Running the Docs Locally

Install the GitDocs NodeJs library

Specifying -g will install the library globally which is what you want to do.

npm install gitdocs -g

Once installed, to run gitdocs you need to navigate to the root directory of the DEV.to codebase and run

gitdocs serve

This will start a server on port 8000

When you add new markdown pages you'll have to stop and start the websever before you see them.