Documentation documentation

Meta.

Run locally

Requirements:

git clone https://github.com/osoc22/project-idlab.git
cd project-idlab/docs/
bundle install
bundle update github-pages
bundle exec jekyll serve

404.html page displayed in the docs when no result is found.
app/ only available on the gh-pages branch. static build of the Svelte frontend, built through GitHub Actions in svelte-to-gh-pages.yml.
assets stores files like the crest svg, icons…
_config.yml is used to configure Jekyll.
- For _config.yml, Just The Docs has multiple configuration options
.gitignore gitignore provided with Jekyll/GitHub Pages repo.
_includes/ contains excerpts & templates used in multiple pages
- clone.md is a bash codeblock with a link to the repo, a cd command into the correct sub-part of the project, and then commands as defined in the include
- repo-page-content.md is the content of the repo page page
- rl.md creates a clean markdown link to the repo. Lower upkeep in case of repo changes, yay.
- spts_setup.md holds instructions to set up solidpod-testserver! These get re-used through multiple different pages.
_sass/custom/custom.scss is a scss file that gets applied to every page, currently used to scale images.
_site/ build artifacts from jekyll serve
Gemfile (& Gemfile.lock) Gemfile used when building the jekyll/github pages site locally.