radicle.xyz website
TheThis is the repository of the radicle.xyz website.
Contribution Guide
Index
Getting Started
Run the following command to start the server:
npx http-server docs -e html
Dependencies
The Website utilises Mustache
You will need to install the same using the following command (A Global Installation):
npm install -g mustache
or using
make dependencies
Making Changes
.html
files. You will lose your work!
- Instead, make edits in corresponding
.html.mustache
file present insidepages/
directory. - You can directly change a
stylesheet
. Stylesheets are present in/docs/styles/
. partials/
directory contains the HTML that is common across all the pages. Like: Header, Footer, etc.
Building
After making the desired changes to .html.mustache
, you will need to build the .html
so that, they can reflect the changes that you have made.
Run the following command(s) while in root directory of the PROJECT:
make
- Building Process requires
mustache
to be installed. - Each
.html.mustache
file in thepages/
directory will result in a.html
file indocs/
directory. - In order for the
make
command to build a file, the file has to be added to theMakefile
Important Information
Conversion of GIF to mp4
The moving images are GIF(s) that have been converted to mp4(s) to keep the size of the page down.
- ffmpeg has been used to make this conversion.
ffmpeg -i file-name.gif -movflags faststart -pix_fmt yuv420p -vf "scale=trunc(iw/2)*2:trunc(ih/2)*2" -b:v 500k file-name.mp4
Legal Information
Copyright © 2019-2022 The Radicle Foundation [email protected]