Skip to content

Latest commit

 

History

History
75 lines (46 loc) · 3.33 KB

README.md

File metadata and controls

75 lines (46 loc) · 3.33 KB
Raw

Baseline Protocol

baseline-protocol.org

Netlify Status

The website is built with Hugo, an open-source static site generator, using a modified Doks theme. It is deployed on Netlify's Content Distribution Network.

Hugo Theme

As theme we have chosen Doks. Doks is a Hugo theme for building secure, fast, and SEO-ready documentation websites, which you can easily update and customize.

Why this theme?

Nine main reasons why we chose Doks:

  1. Security aware. Get A+ scores on Mozilla Observatory out of the box. Easily change the default Security Headers to suit your needs.

  2. Fast by default. Get 100 scores on Google Lighthouse by default. Doks removes unused css, prefetches links, and lazy loads images.

  3. SEO-ready. Use sensible defaults for structured data, open graph, and Twitter cards. Or easily change the SEO settings to your liking.

  4. Development tools. Code with confidence. Check styles, scripts, and markdown for errors and fix automatically or manually.

  5. Bootstrap framework. Build robust, flexible, and intuitive websites with Bootstrap 5. Easily customize your Doks site with the source Sass files.

  6. Netlify-ready. Deploy to Netlify with sensible defaults. Easily use Netlify Functions, Netlify Redirects, and Netlify Headers.

  7. Full text search. Search your Doks site with FlexSearch. Easily customize index settings and search options to your liking.

  8. Page layouts. Build pages with a landing page, blog, or documentation layout. Add custom sections and components to suit your needs.

  9. Dark mode. Switch to a low-light UI with the click of a button. Change colors with variables to match your branding.

Requirements

Doks uses npm to centralize dependency management, making it easy to update resources, build tooling, plugins, and build scripts. It also leverages nvm (Node Version Manager) which allows you to quickly install and use different versions of node via the command line.

Contribute

You want to contribute to the Baseline website? Awesome! Get up and running in three steps:

1. Clone repo

git clone https://github.com/ethereum-oasis-op/baseline-website.git baseline-website && cd baseline-website

2. Switch to proper Node version and install dependencies

nvm use && npm install

3. Start development server

npm run start