Welcome to the drand documentation website! The live site can be found at https://drand.love.
If you want to build this site locally, run the following:
Clone this repository:
git clone https://github.com/drand/website.git
Move into the website
folder and install the npm dependencies:
cd website
npm install
Boot up the application in dev mode:
npm start
Open localhost:8084 in your browser.
Close the local server with CTRL
+ c
.
To restart the local server, run npm start
from within the website
folder.
Note: You'll need to use NodeJS version 16, e.g. 16.19.1. At the moment, NodeJS 18 or newer is not supported.
Within the /docs/blog
directory, create a new markdown document for the blog post. It should be the date of the post as YYYY-MM-DD
followed by the post title in kebab-case
and finally the extension .md
. So, a post called Bill and Teds Excellent Randomness Protocol created on Monday 25th May 2020 would look like /docs/blog/2020-05-25-bill-and-teds-excellent-randomness-protocol.md
.
If you need to add images into your post, first copy and paste them into the blog folder, then reference them within your post using [Image caption](./image-name.png)
. You must prefix the path with ./
or the image will not display correctly on the website.
Before you write the post, add the following meta data using YAML front matter:
---
title: The title of your blog post, note you do not need to repeat this in the post content
summary: A short summary of the blog post for display in the post index page.
date: 2020-08-10
tags:
- Grouping
- Tags
- Relevant
- To
- The
- Post
---
Always test that you blog post is displaying correctly before merging anything into master
.
Commits on master automatically deploy the updated website to https://drand.love using Fleek. Commits on side branches provide a preview build in their fleek/build
check.
See this entry in Fleek's documentation for more details on how that happens.