Skip to content

README.md

Latest commit

 

History

History
52 lines (35 loc) · 993 Bytes

README.md

File metadata and controls

52 lines (35 loc) · 993 Bytes

Documentation Scripts

Developer Guide to Creating and Running the Docs Locally

Prerequisites

  • Ruby and Bundler installed
  • Node.js installed
  • macOS users need to use Rosetta for Jekyll (x86_64 emulation)

Steps

  1. Create and prepare the site-src directory:
mkdir -p site-src
cp -r docs/* site-src/
cd site-src
  1. Run the documentation processing scripts:
chmod +x ../.github/scripts/docs/process-docs.sh
../.github/scripts/docs/process-docs.sh

chmod +x ../.github/scripts/docs/fix-docs.sh
../.github/scripts/docs/fix-docs.sh

cd ..
chmod +x .github/scripts/docs/create-jekyll-config.sh
.github/scripts/docs/create-jekyll-config.sh
cd site-src
  1. Install Jekyll dependencies:
sudo bundle install
  1. Start the Jekyll server:
arch -x86_64 bundle exec jekyll serve
  1. View the documentation:

Open your browser and go to: http://127.0.0.1:4000/forms-engine-plugin/

To stop the server: Press Ctrl+C