jeanescoto / light-doc

The hugo documents and templates repo that will be built to https://doc.networknt.com

Documentation source code for https://doc.networknt.com site which is generated by the Hugo.

Stack Overflow | Google Group | Gitter Chat | Subreddit | Youtube Channel | Documentation | Contribution Guide |

Contributing

For each page in the document site, there is a source markdown file in this repo under the content folder. If you encounter any issue with the documentation, please open an issue or submit a PR.

Branches

• The develop branch is where the latest updates are merged into. All developers will be working against this branch.
• The master branch is where the site is built from and is matching with the document site exactly.
• The next branch is where we push the changes to release the document site from the master branch

Build and Test

To view the documentation site locally, you need to clone this repository and install Hugo on your computer.

Then to view the docs in your browser, run Hugo and open up the link http://localhost:1313/ on your browser:

▶ hugo server

Started building sites ...
.
.
Serving pages from memory
Web Server is available at http://localhost:1313/ (bind address 127.0.0.1)
Press Ctrl+C to stop