Giter Club home page Giter Club logo

frescobaldi.org-mkdocs's Introduction

Frescobaldi website

The website is built using Mkdocs and the mkdocs-material theme. You can install them using pip:

pip3 install --user mkdocs mkdocs-material

When you edit the website content, you should run the server in order to see the changes on browser while you write the markdown files:

mkdocs serve

When your work is done, you can build the static website:

mkdocs build

Mkdocs has built-in support to deploy the static site to Github Pages:

mkdocs gh-deploy

The static site of this repository is currently deployed at https://fedelibre.github.io/frescobaldi.org-mkdocs/.

TODO

This is a work in progress.

Add content

We should discuss what to use from the existing user guide and how to restructure the content.

Mkdocs does not support variables (as in our user guide) within Markdown files. Check issue 304.

LilyPond code syntax highlight

Urs suggested writing a Mkdocs plugin to preprocess lilypond snippets with python-ly highlighter.

Another option would be writing a lilypond highlighter for Pygments, see CodeHilite extension.

Content translation

Mkdocs does not currently support content translation. See the discussion in issue 211.

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.