Giter Club home page Giter Club logo

biscuit-website's Introduction

Biscuit website

The website is made up of two parts: the main website (https://biscuitsec.org) and the documentation website (https://doc.biscuitsec.org). Both sites require a JS bundle for editor components to work correctly.

Required tools

The website requires the following tools:

  • npm for bundling frontend assets
  • zola for building the main website
  • mdbook for building the documentation website

zola and mdbook can be downloaded from the release pages:

npm can be installed through your operating system tooling or via nvm.

Frontend build

  • go to the wc/ directory
  • npm install
  • npm run build

Preview the main website output

  • make sure you've built the frontend bundle
  • run zola serve
  • point your browser to the URL displayed in the console output

Running zola build and opening generated files directly in your browser won't work as the datalog component files require being served over HTTP.

Preview the documentation output

  • make sure you've built the frontend bundle
  • go to the docs/ directory
  • run mdbook serve
  • point your browser to the URL displayed in the console output

Running mdbook serve and opening generated files directly in your browser won't work as the datalog component files require being served over HTTP.

biscuit-website's People

Contributors

divarvel avatar geal avatar juliabenisty avatar clementd-fretlink avatar ptitfred avatar malcolmstill avatar gssakash avatar urcadox avatar ltearno avatar jtanguy avatar ljahier avatar quad avatar bastienvigneron avatar nwalsh1995 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.