doc: explicit Markdown anchors for top-level headings; remove metadata

I used the existing anchors generated by Docbook, so the anchor part
should be a no-op. This could be useful depending on the
infrastructure we choose to use, and it is better to be explicit than
rely on Docbook's id generating algorithms.

I got rid of the metadata segments of the Markdown files, because they
are outdated, inaccurate, and could make people less willing to change
them without speaking with the author.
This commit is contained in:
Ryan Mulligan 2021-01-01 09:45:43 -08:00
parent 70a061bd6c
commit b8344f9e5c
19 changed files with 19 additions and 76 deletions

View file

@ -1,4 +1,4 @@
# Cataclysm: Dark Days Ahead # Cataclysm: Dark Days Ahead {#cataclysm-dark-days-ahead}
## How to install Cataclysm DDA ## How to install Cataclysm DDA

View file

@ -37,7 +37,7 @@ This works just like `runCommand`. The only difference is that it also provides
Variant of `runCommand` that forces the derivation to be built locally, it is not substituted. This is intended for very cheap commands (<1s execution time). It saves on the network roundrip and can speed up a build. Variant of `runCommand` that forces the derivation to be built locally, it is not substituted. This is intended for very cheap commands (<1s execution time). It saves on the network roundrip and can speed up a build.
::: {.note} ::: note
This sets [`allowSubstitutes` to `false`](https://nixos.org/nix/manual/#adv-attr-allowSubstitutes), so only use `runCommandLocal` if you are certain the user will always have a builder for the `system` of the derivation. This should be true for most trivial use cases (e.g. just copying some files to a different location or adding symlinks), because there the `system` is usually the same as `builtins.currentSystem`. This sets [`allowSubstitutes` to `false`](https://nixos.org/nix/manual/#adv-attr-allowSubstitutes), so only use `runCommandLocal` if you are certain the user will always have a builder for the `system` of the derivation. This should be true for most trivial use cases (e.g. just copying some files to a different location or adding symlinks), because there the `system` is usually the same as `builtins.currentSystem`.
::: :::

View file

@ -1,9 +1,4 @@
--- # Agda {#agda}
title: Agda
author: Alex Rice (alexarice)
date: 2020-01-06
---
# Agda
## How to use Agda ## How to use Agda

View file

@ -1,9 +1,4 @@
--- # Android {#android}
title: Android
author: Sander van der Burg
date: 2018-11-18
---
# Android
The Android build environment provides three major features and a number of The Android build environment provides three major features and a number of
supporting features. supporting features.

View file

@ -1,4 +1,4 @@
# Crystal # Crystal {#crystal}
## Building a Crystal package ## Building a Crystal package

View file

@ -1,4 +1,4 @@
# Emscripten # Emscripten {#emscripten}
[Emscripten](https://github.com/kripken/emscripten): An LLVM-to-JavaScript Compiler [Emscripten](https://github.com/kripken/emscripten): An LLVM-to-JavaScript Compiler

View file

@ -1,10 +1,4 @@
--- # Haskell {#haskell}
title: User's Guide for Haskell in Nixpkgs
author: Peter Simons
date: 2015-06-01
---
# Haskell
The documentation for the Haskell infrastructure is published at The documentation for the Haskell infrastructure is published at
<https://haskell4nix.readthedocs.io/>. The source code for that <https://haskell4nix.readthedocs.io/>. The source code for that

View file

@ -1,4 +1,4 @@
# Idris # Idris {#idris}
## Installing Idris ## Installing Idris

View file

@ -1,9 +1,4 @@
--- # iOS {#ios}
title: iOS
author: Sander van der Burg
date: 2019-11-10
---
# iOS
This component is basically a wrapper/workaround that makes it possible to This component is basically a wrapper/workaround that makes it possible to
expose an Xcode installation as a Nix package by means of symlinking to the expose an Xcode installation as a Nix package by means of symlinking to the

View file

@ -1,10 +1,4 @@
--- # User's Guide to Lua Infrastructure {#users-guide-to-lua-infrastructure}
title: Lua
author: Matthieu Coudron
date: 2019-02-05
---
# User's Guide to Lua Infrastructure
## Using Lua ## Using Lua

View file

@ -1,10 +1,4 @@
--- # Maven {#maven}
title: Maven
author: Farid Zakaria
date: 2020-10-15
---
# Maven
Maven is a well-known build tool for the Java ecosystem however it has some challenges when integrating into the Nix build system. Maven is a well-known build tool for the Java ecosystem however it has some challenges when integrating into the Nix build system.

View file

@ -1,5 +1,5 @@
Node.js # Node.js {#node.js}
=======
The `pkgs/development/node-packages` folder contains a generated collection of The `pkgs/development/node-packages` folder contains a generated collection of
[NPM packages](https://npmjs.com/) that can be installed with the Nix package [NPM packages](https://npmjs.com/) that can be installed with the Nix package
manager. manager.

View file

@ -1,4 +1,4 @@
# Python # Python {#python}
## User Guide ## User Guide

View file

@ -1,5 +1,4 @@
R # R {#r}
=
## Installation ## Installation

View file

@ -1,10 +1,4 @@
--- # Rust {#rust}
title: Rust
author: Matthias Beyer
date: 2017-03-05
---
# Rust
To install the rust compiler and cargo put To install the rust compiler and cargo put

View file

@ -1,4 +1,3 @@
# TeX Live {#sec-language-texlive} # TeX Live {#sec-language-texlive}
Since release 15.09 there is a new TeX Live packaging that lives entirely under attribute `texlive`. Since release 15.09 there is a new TeX Live packaging that lives entirely under attribute `texlive`.

View file

@ -1,9 +1,4 @@
--- # Titanium {#titanium}
title: Titanium
author: Sander van der Burg
date: 2018-11-18
---
# Titanium
The Nixpkgs repository contains facilities to deploy a variety of versions of The Nixpkgs repository contains facilities to deploy a variety of versions of
the [Titanium SDK](https://www.appcelerator.com) versions, a cross-platform the [Titanium SDK](https://www.appcelerator.com) versions, a cross-platform

View file

@ -1,9 +1,4 @@
--- # Vim {#vim}
title: User's Guide for Vim in Nixpkgs
author: Marc Weber
date: 2016-06-25
---
# Vim
Both Neovim and Vim can be configured to include your favorite plugins Both Neovim and Vim can be configured to include your favorite plugins
and additional libraries. and additional libraries.

View file

@ -1,10 +1,4 @@
--- # Preface {#preface}
title: Preface
author: Frederik Rietdijk
date: 2015-11-25
---
# Preface
The Nix Packages collection (Nixpkgs) is a set of thousands of packages for the The Nix Packages collection (Nixpkgs) is a set of thousands of packages for the
[Nix package manager](https://nixos.org/nix/), released under a [Nix package manager](https://nixos.org/nix/), released under a