This documentation is rendered online at ***http://127.0.0.1:4000/docs/introduction.html***(after serving)
Jekyll is a simple, extendable, static site generator. You give it text written in your favorite markup language and it churns through layouts to create a static website. Throughout that process you can tweak how you want the site URLs to look, what data gets displayed in the layout, and more.(more details refer to https://jekyllrb.com/)
You can build the doc locally but before you need to install some packages on your machine
-
Ruby: may check through command if installed in your machine or not
ruby -v -
Gems: may check through command if installed in your machine or not
gem -v
-
After the installation process has been finished.
-
Execute command
gem install jekyll bundlerin your terminal. -
Clone the 'Bagisto Docs' project from github.
-
And, to start the Bagisto documentation on your machine execute below command in terminal
bundle exec jekyll serve
-
Use the Server address URL http://127.0.0.1:4000/ in a browser to preview the content.
-
Press Ctrl+C in the serve terminal to stop the server.
Now, the 'Bagisto Docs' project have been set up on your machine, you can improve or read the doc on your machine.
TIP :Leave the serve terminal open and running. Every time you save changes to a file, it automatically regenerates the site so you can test the output immediately.