git.iko.soy/typeable/nixpkgs
on master help sign in
Merge pull request #108147 from ryantm/doc-cleanup

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

commitdd6c0efa628763b5f486eb3ad40599d45622ffa7 authorRyan Mulligan <ryan@ryantm.com> dateFri 1 Jan 2021, 11:40 (6 years ago) parent5c631aeb8344f9
19 files changed+19−76
doc/builders/packages/cataclysm-dda.section.md+1−1 doc/builders/trivial-builders.chapter.md+1−1 doc/languages-frameworks/agda.section.md+1−6 doc/languages-frameworks/android.section.md+1−6 doc/languages-frameworks/crystal.section.md+1−1 doc/languages-frameworks/emscripten.section.md+1−1 doc/languages-frameworks/haskell.section.md+1−7 doc/languages-frameworks/idris.section.md+1−1 doc/languages-frameworks/ios.section.md+1−6 doc/languages-frameworks/lua.section.md+1−7 doc/languages-frameworks/maven.section.md+1−7 doc/languages-frameworks/node.section.md+2−2 doc/languages-frameworks/python.section.md+1−1 doc/languages-frameworks/r.section.md+1−2 doc/languages-frameworks/rust.section.md+1−7 doc/languages-frameworks/texlive.section.md−1 doc/languages-frameworks/titanium.section.md+1−6 doc/languages-frameworks/vim.section.md+1−6 doc/preface.chapter.md+1−7
doc/builders/packages/cataclysm-dda.section.md+1−1
@@ -1,4 +1,4 @@
1−# Cataclysm: Dark Days Ahead
1+# Cataclysm: Dark Days Ahead {#cataclysm-dark-days-ahead}
22
33## How to install Cataclysm DDA
44
doc/builders/trivial-builders.chapter.md+1−1
@@ -37,7 +37,7 @@ This works just like `runCommand`. The only difference is that it also provides
3737
3838Variant 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.
3939
40−::: {.note}
40+::: note
4141This 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`.
4242:::
4343
doc/languages-frameworks/agda.section.md+1−6
@@ -1,9 +1,4 @@
1−---
2−title: Agda
3−author: Alex Rice (alexarice)
4−date: 2020-01-06
5−---
6−# Agda
1+# Agda {#agda}
72
83## How to use Agda
94
doc/languages-frameworks/android.section.md+1−6
@@ -1,9 +1,4 @@
1−---
2−title: Android
3−author: Sander van der Burg
4−date: 2018-11-18
5−---
6−# Android
1+# Android {#android}
72
83The Android build environment provides three major features and a number of
94supporting features.
doc/languages-frameworks/crystal.section.md+1−1
@@ -1,4 +1,4 @@
1−# Crystal
1+# Crystal {#crystal}
22
33## Building a Crystal package
44
doc/languages-frameworks/emscripten.section.md+1−1
@@ -1,4 +1,4 @@
1−# Emscripten
1+# Emscripten {#emscripten}
22
33[Emscripten](https://github.com/kripken/emscripten): An LLVM-to-JavaScript Compiler
44
doc/languages-frameworks/haskell.section.md+1−7
@@ -1,10 +1,4 @@
1−---
2−title: User's Guide for Haskell in Nixpkgs
3−author: Peter Simons
4−date: 2015-06-01
5−---
6−
7−# Haskell
1+# Haskell {#haskell}
82
93The documentation for the Haskell infrastructure is published at
104<https://haskell4nix.readthedocs.io/>. The source code for that
doc/languages-frameworks/idris.section.md+1−1
@@ -1,4 +1,4 @@
1−# Idris
1+# Idris {#idris}
22
33## Installing Idris
44
doc/languages-frameworks/ios.section.md+1−6
@@ -1,9 +1,4 @@
1−---
2−title: iOS
3−author: Sander van der Burg
4−date: 2019-11-10
5−---
6−# iOS
1+# iOS {#ios}
72
83This component is basically a wrapper/workaround that makes it possible to
94expose an Xcode installation as a Nix package by means of symlinking to the
doc/languages-frameworks/lua.section.md+1−7
@@ -1,10 +1,4 @@
1−---
2−title: Lua
3−author: Matthieu Coudron
4−date: 2019-02-05
5−---
6−
7−# User's Guide to Lua Infrastructure
1+# User's Guide to Lua Infrastructure {#users-guide-to-lua-infrastructure}
82
93## Using Lua
104
doc/languages-frameworks/maven.section.md+1−7
@@ -1,10 +1,4 @@
1−---
2−title: Maven
3−author: Farid Zakaria
4−date: 2020-10-15
5−---
6−
7−# Maven
1+# Maven {#maven}
82
93Maven is a well-known build tool for the Java ecosystem however it has some challenges when integrating into the Nix build system.
104
doc/languages-frameworks/node.section.md+2−2
@@ -1,5 +1,5 @@
1−Node.js
2−=======
1+# Node.js {#node.js}
2+
33The `pkgs/development/node-packages` folder contains a generated collection of
44[NPM packages](https://npmjs.com/) that can be installed with the Nix package
55manager.
doc/languages-frameworks/python.section.md+1−1
@@ -1,4 +1,4 @@
1−# Python
1+# Python {#python}
22
33## User Guide
44
doc/languages-frameworks/r.section.md+1−2
@@ -1,5 +1,4 @@
1−R
2−=
1+# R {#r}
32
43## Installation
54
doc/languages-frameworks/rust.section.md+1−7
@@ -1,10 +1,4 @@
1−---
2−title: Rust
3−author: Matthias Beyer
4−date: 2017-03-05
5−---
6−
7−# Rust
1+# Rust {#rust}
82
93To install the rust compiler and cargo put
104
doc/languages-frameworks/texlive.section.md−1
@@ -1,4 +1,3 @@
1−
21# TeX Live {#sec-language-texlive}
32
43Since release 15.09 there is a new TeX Live packaging that lives entirely under attribute `texlive`.
doc/languages-frameworks/titanium.section.md+1−6
@@ -1,9 +1,4 @@
1−---
2−title: Titanium
3−author: Sander van der Burg
4−date: 2018-11-18
5−---
6−# Titanium
1+# Titanium {#titanium}
72
83The Nixpkgs repository contains facilities to deploy a variety of versions of
94the [Titanium SDK](https://www.appcelerator.com) versions, a cross-platform
doc/languages-frameworks/vim.section.md+1−6
@@ -1,9 +1,4 @@
1−---
2−title: User's Guide for Vim in Nixpkgs
3−author: Marc Weber
4−date: 2016-06-25
5−---
6−# Vim
1+# Vim {#vim}
72
83Both Neovim and Vim can be configured to include your favorite plugins
94and additional libraries.
doc/preface.chapter.md+1−7
@@ -1,10 +1,4 @@
1−---
2−title: Preface
3−author: Frederik Rietdijk
4−date: 2015-11-25
5−---
6−
7−# Preface
1+# Preface {#preface}
82
93The Nix Packages collection (Nixpkgs) is a set of thousands of packages for the
104[Nix package manager](https://nixos.org/nix/), released under a