This folder contains the documentation for Code-Forge, using the Just the Docs Jekyll theme.
- Ruby installed (version 2.7.0 or higher recommended)
- Bundler gem installed (
gem install bundler)
-
Navigate to the docs directory:
cd docs -
Install dependencies:
bundle install
-
Start the local server:
bundle exec jekyll serve -
Open your browser and go to:
http://localhost:4000
-
All documentation is written in Markdown (.md) files
-
Each file should have front matter at the top like this:
--- layout: page title: Page Title nav_order: 2 description: "Description of the page" permalink: /page-url ---
-
The
nav_ordervalue determines the position in the navigation menu
index.md: Home pageonboarding.md: Onboarding guideguidelines.md: Development guidelinesservice.md: Service documentation_config.yml: Jekyll configurationGemfile: Ruby gem dependencies
The Just the Docs theme is configured in _config.yml. Refer to the Just the Docs documentation for customization options.