Skip to content

About

A landing page for myst-contrib

Resources

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

11 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

myst-contrib.github.io

The landing page for the myst-contrib organization, served at https://myst-contrib.github.io.

How it works

The site is a MyST Markdown site in docs/. At build time, noxfile.py writes two files:

  • docs/index.md: the org-wide README, with a list of projects added after its intro.
  • docs/repos.json: the org's repositories, from the gh CLI. The myst-listing plugin shows them on the landing page and on docs/repositories.md.

The deploy workflow rebuilds the site on every push to main and once a day, so changes to the org README and repositories show up within a day.

To change the landing page text, edit the org README in myst-contrib/.github. To change a project's entry, edit that repository's description, topics, or homepage on GitHub.

Build locally

Use nox, which generates the pages and runs MyST for you. You need the gh CLI installed and logged in, because noxfile.py uses it to list the repositories.

nox -s docs       # build static HTML in docs/_build/html
nox -s docs-live  # start a live development server

About

A landing page for myst-contrib

Resources

Stars

0 stars

Watchers

0 watching

Forks

Contributors

Languages