Skip to content
Openfluid community documentation
TeX HTML Python CSS JavaScript Dockerfile Shell
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
resources
scripts
src
.gitignore
CONTRIBUTING.md
LICENSE.3rdPARTY.md
LICENSE.md
README.md
TODO.md
builder-env
docker-compose-builder.yml

README.md

OpenFLUID Community documentation

Documentation sources

The documentation sources are located in the src directory. It is made of a set of simple pages, written in markdown and powered by MkDocs. MkDocs 1.0 or higher is required.
The main page of this documentation is the src/docs/index.md file.

Builder environment

The builder environment is a docker container that includes tools to generate the site. To setup this environment and run command into this, just run the build script:

./build-env

Build operations

Once the shell from the container is running, you can use scripts located in /workdir/scripts:

  • build for building the community site

The build results are available in the _build directory

You can’t perform that action at this time.