https://github.com/noteed/git-notes
A collection of short notes about Git
https://github.com/noteed/git-notes
Last synced: 2 months ago
JSON representation
A collection of short notes about Git
- Host: GitHub
- URL: https://github.com/noteed/git-notes
- Owner: noteed
- Created: 2019-11-30T11:22:08.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-12-07T20:31:22.000Z (over 6 years ago)
- Last Synced: 2025-12-25T21:20:57.787Z (6 months ago)
- Language: Nix
- Homepage: https://noteed.com/git-notes/
- Size: 9.77 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Git notes
This is a collection of short notes about Git. When some commands are
demonstrated, they are run using Nix to capture the results, which are then
embedded into Markdown files. Those files can be further processed to build
HTML files, e.g. with Pandoc.
## List of notes
Each note starts with the command to build its associated Nix derivation. The
available notes are:
- [`git init`](generated/init.md)
## Building
Each repository and associated documentation can be built separately. For
instance, to build a repository demonstrating the [`git
init`](generated/init.md) command, one can run:
```
$ nix-build -A init
```
To build the Markdown file corresponding to that same command:
```
$ nix-build site/ -A md.init
```
To build all the notes as Markdown, these two commands are equivalent:
```
$ nix-build site/ -A md.all
```
To build the HTML file corresponding to that same command:
```
$ nix-build site/ -A html.init
```
To build all the notes as HTML, these two commands are equivalent:
```
$ nix-build site/ -A html.all
$ nix-build -A site
```
The generated Markdown files can be seen in the `generated/` directory.