🎧 MuxFM Docs

⚠️ Under construction: This repository will contain the docs and landing pages for this project. The website is built using Docusaurus 2, a modern static website generator.

📋 Content

The ./docs directory including all the docs for MuxFM projects:

• docs/glue: Docs for Glue
• docs/site: Docs for static site generator

🛠️ Domain

Currently, this website is hosted on https://muxfm.github.io/docs, not the root subdomain.

This is because we want to publish the site from the gh-pages branch. The master branch has raw markdown files, and the static site is built and deployed from gh-pages. However, GitHub forces organization and user sites to deploy from the master branch:

The solution: Soon, we'll get a domain (free ones like muxfm.js.org or paid ones like mux.fm are both available), so we won't need to use the muxfm.github.io domain.

👩‍💻 Development

Start a local development server:

npm run start

Build for productionin the build dir:

npm run build

📄 License

• Code: MIT
• Content and static assets: CC BY 4.0