This repository hosts the website content for the Marble Project. This website contains information about the
project as well as tutorials (as a submodule under marble-tutorials/
).
python3 -m pip install -r requirements.txt
python3 build.py
By default, all files will be written to the build/
directory. To specify a different directory use the -b
option
when calling build.py
.
By default, node information will be read from
the default DACCS node registry. To specify a different URL use the -u
option when calling build.py
[!NOTE] If you've just cloned the repository, ensure that the marble-tutorials submodule has been cloned as well:
git submodule init git submodule update
If pulling changes from the main repository, run the following to ensure the submodule is picked up as well:
git pull --recurse-submodules
The files in build directory can be served as a static website. For example:
cd build/
python3 -m http.server 8000
This will start a basic http server that can be accessed at http://localhost:8000
(Note that this is recommended for development only)
This is how the files are arranged in this repo and how to update them in order to develop this website.
static/
directory will be copied to the build directory without modification.templates/site/
directory will be copied to the build directory after being updated by the template enginetemplates/
directory will not be copied to the build directory but will be used by the templating engine
templates/layouts/
contains files that should be extended by other template filestemplates/partials/
contain files that should be included by other template filessnippets/
directory will not be included in the build directory by default. These files will only be included if they are manually added in the build.py
script.The template engine used is Jinja.