The Bash Site Generator is a piece of software to help in the creation of courses which will be rendered as Markdown files, including an index, etc.
The generator is a collection of scripts that can be executed step by step to:
- create a series of localised templates to pages
- automatically fill in a predefined amount of pages to compose a site
- generate an index file to help navigating the final site
- generate a navigation bar in every page with Next and Previous links
- store the whole site as a spreadsheet for easier editing
- render the site from the spreadsheet as a series of markdown files
- automatically create empty code files for every code block with the right titles for you to fill in
- visualise the site as part of Github pages
- includes block for video, images, code, plain text, HTML, and licenses
- code blocks come with color coding for: C, C++, Processing, JavaScript, Python
First, open a terminal window, clone the repo, and navigate to the build folder.
There will be a lot of data pushed out to the CLI, check whether there are any errors.
In this example, we are using a simplified template using just an introduction and a video field (plus license, name, and index fields). Use less [path] to see the contents of any of the pages.
The code will also render an index page with links to all of the pages in the site.
Bash is a very powerful and simple command line scripting mechanism.
The documentation to the Bash Site Generator has been made with the Bash Site Generator. Check:
The content's scaffolding is created by running the build process. Check:
See THE LOGS FILE for a full day-to-day update of the creation of this project.
Do you wanna know what I have in mind for this project? Read about it in my TODO LIST
pre-alpha a.k.a. Twosday edition published on 22022022
Do you need one? Yepp, I got you covered, I used CC0.