Giter Club home page Giter Club logo

faustwebsite's Introduction

Faust Website

This repository contains the source of the Faust website which is currently deployed at https://faust.grame.fr.

Prerequisites

  • you must have python and pip installed.

Building the web site

The build process is based on make. Building the documentation site is based on mkdocs. To install the required components, type:

$ make install

To generate the web site, type:

$ make build

You'll find the web site in the ./docs folder.

Testing and generating

You can test the web site using the mkdoc embedded web server. This server also scan any change in the source directory and refresh the pages dynamically which is really convenient for the development process. To launch the server type:

$ make serve

More details about the build process. Type:

$ make help

Publishing

The docs folder at rool level contains all files that will be published. To make the current version publicly available:

  • add all the new files using git add docs
  • commit using git commit -am "message" (so new files and deleted files will be commited, except docs/CNAME file)
  • and push the commit

faustwebsite's People

Contributors

sletz avatar orlarey avatar rmichon avatar dfober avatar marclava avatar mdazad1508 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.