Handbook
which contains all the documentation regarding all the island.is projects. You will find technical overview, architectural decisions, api, devops, code reviews, code standards detailed information and much more. If you need to edit an existing documentation or create a new page inside the handbook directory, you simply have to create a markdown
file and start writing your content.README.md
which are all the readmes from the apps
and libs
directories contained in the sub folders. The same goes for the README.md. Simply add your content using markdown. We only recommend one thing, is to use this template when you create a new app in the apps
directory.README.md
within handbook
directoryREADME.md
files from directories inside the handbook/
directory are used to create the navigation structure when running the yarn gitbook
command.README.md
with a H1
heading (example) — but apart from that, you may leave it empty and GitBook will automatically display the sub file structure.../../../
before finding the file you want to link to.assets
folder inside the directory where you need it. You can then access your assets from your markdown file by doing ./assets/my-image.png
.handbook
directory or new README.md
located inside the apps
or libs
directories and add it to the SUMMARY.md
file, which is the file used by GitBook to create the navigation structure.SUMMARY.md
will be alphabetically ordered and organised in folders/sub-folders for the apps
and libs
.main
, it will take a few minutes before your changes appears on docs.devland.is.<!-- gitbook-navigation: "Navigation Title" -->
SUMMARY.md
file and included inside the GitBook, you can add the following html comment <!-- gitbook-ignore -->
as the first line of the file.