diff --git a/README.md b/README.md index 2796ad0..09f7c47 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,8 @@ -## Fedidevs.org +# Fedidevs.org This is the content of [fedidevs.org](https://fedidevs.org/). -It is built with the [Hugo](https://gohugo.io/) static site generator, plus some -Python scripts that generate a few of the pages. +It is built with the [Hugo](https://gohugo.io/) static site generator, plus some Python scripts that generate a few of the pages. Contributions welcome; file a pull request. @@ -11,7 +10,7 @@ Contributions welcome; file a pull request. Install Git and Git-LFS, and initialize it: -``` +```shell $ brew install git $ brew install git-lfs $ git lfs install @@ -19,7 +18,7 @@ $ git lfs install Install Hugo, e.g. on the Mac: -``` +```shell $ brew install hugo ``` @@ -27,7 +26,7 @@ $ brew install hugo Get the content: -``` +```shell $ git clone https://github.com/fediverse-devnet/fedidevs.org.git $ cd fedidevs.org $ git submodule update @@ -35,56 +34,44 @@ $ git submodule update Run: -``` +```shell $ hugo server ``` -Then go to ``http://localhost:1313/`` (actual port will be printed to the terminal). +Then go to `http://localhost:1313/` (actual port will be printed to the terminal). ## Making changes -If you are not familiar with Hugo, leave all files and directories alone except for -what's in directory ``content/``. There, you find the Markup files that make up the -content of the site. +If you are not familiar with Hugo, leave all files and directories alone except for what's in the `content/` directory. There, you'll find the Markup files that make up the content of the site. -By and large, there are two kinds of files there: +By and large, there are two kinds of content files: -* Normally named Markdown files, such as ``content/foo/bar/baz.md``. This is a "leaf" node - in the page hierarchy, i.e. it will have no child pages. The content will be at URL - ``http://localhost:1313/foo/bar/baz/``. +* Standard Markdown files, such as `content/foo/bar/baz.md`. This is a "leaf" node in the page hierarchy, i.e. it will have no child pages. The content will be at URL `http://localhost:1313/foo/bar/baz/`. -* Markdown files named ``_index.md``, such as a ``content/bar/foo/_index.md``. This is a - "directory" node in the page hierarchy, i.e. it can have further child pages. It is a - regular markdown file whose content will be at URL ``http://localhost:1313/bar/foo/``. - But it uses a different layout generation algorithm that automatically inserts links - to its child pages. +* Markdown files named with an underscore prefix `_index.md`, such as a `content/bar/foo/_index.md`. This is a "directory" node in the page hierarchy, i.e. it can have further child pages. It is a regular Markdown file whose content will be at URL `http://localhost:1313/bar/foo/`. It uses a different layout generation algorithm that automatically inserts links to its child pages. ## Intended structure of the site -This describes files below ``content/``. +This describes files below `content/`. * Front page: Welcome, overview -* ``best-practices/``: A collection of best practices that we consider useful. Not standards, but more - tips and tricks how to best apply the standards to solve certain problems. +* `best-practices/`: A collection of best practices that we consider useful. Not standards, but more tips and tricks how to best apply the standards to solve certain problems. -* ``notes/``: Notes from meetings +* `notes/`: Notes from meetings -* ``projects/``: Contains all information about Fediverse software projects, further subdivided - by category. +* `projects/`: Contains all information about Fediverse software projects, further subdivided by category. -* ``projects/libraries/``: Information about Fediverse-related software libraries. +* `projects/libraries/`: Information about Fediverse-related software libraries. -* ``projects/server-apps/``: Information about Fediverse server-side applications. +* `projects/server-apps/`: Information about Fediverse server-side applications. -* ``projects/mobile-apps/``: Information about Fediverse mobile apps. +* `projects/mobile-apps/`: Information about Fediverse mobile apps. -* ``reference/`` Collection of reference information that is useful for development, such as an - overview over how the ActivityPub actor files look for different server apps. - Much content here is generated. +* `reference/`: Collection of reference information that is useful for development, such as an overview over how the ActivityPub actor files look for different server apps. Much content here is generated. ## Other directories -* ``static/``: Static assets, such as images. +* `static/`: Static assets, such as images. -* ``scripts/``: Scripts that generate content for the site. +* `scripts/`: Scripts that generate content for the site.