mkdocs.yml · haskell.nix

git.iko.soy/haskell.nix

on preflake help sign in

haskell.nix/mkdocs.yml

59 lines 2.3 kB history raw

1# You can use mkdocs from nix, by running the following:

3# nix-shell -p mkdocs

5# that should pop you into a shell, where you can then

6# run

8# mkdocs serve

10# and point your browser to localhost:8000

11#

12site_name: Alternative Haskell Infrastructure for Nixpkgs

13theme: readthedocs

14site_url: null

15repo_url: https://github.com/input-output-hk/haskell.nix

16permalink: true

17markdown_extensions:

18 - admonition

19 - footnotes

20 - tables

21 - toc:

22 permalink: true

24# this is called `nav` in more recent mkdocs versions. Mine

25# right now is 0.17.5

26pages:

27 - 'Introduction': index.md

28 - 'Motivation': motivation.md

29 - 'Architecture': architecture.md

30 - 'Tutorials':

31 - 'Getting Started': tutorials/getting-started.md

32 - 'Getting started with Flakes': tutorials/getting-started-flakes.md

33 - 'Creating a development environment': tutorials/development.md

34 - 'Sourcing files only part of git repository using cleanGit': tutorials/clean-git.md

35 - 'Handling git repositories in projects': tutorials/source-repository-hashes.md

36 - 'Mapping non-Haskell dependencies to Nixpkgs': tutorials/pkg-map.md

37 - 'Bumping Hackage and Stackage snapshots': tutorials/hackage-stackage.md

38 - 'Materialization: Speeding up Nix evaluation': tutorials/materialization.md

39 - 'Cross-compiling your project': tutorials/cross-compilation.md

40 - 'Generating coverage information': tutorials/coverage.md

41 - 'Reference':

42 - 'Suported GHC versions': reference/supported-ghc-versions.md

43 - 'Command-line tools': reference/commands.md

44 - 'Haskell.nix Library': reference/library.md

45 - 'Module options': reference/modules.md

46 - 'Troubleshooting': troubleshooting.md

47 - 'Templates / Abstraction':

48 - 'IOHKs nix library': iohk-nix.md

49 - 'Dev Notes':

50 - 'Architecture': dev/dev-architecture.md

51 - 'Installing nix-tools': dev/installing-nix-tools.md

52 - 'Manually generating Nix expressions': dev/manually-generating-nix-expressions.md

53 - 'Maintainer Scripts': dev/maintainer-scripts.md

54 - 'Nixpkgs Pin': dev/nixpkgs-pin.md

55 - 'Removing withPackage wrapper': dev/removing-with-package-wrapper.md

56 - 'Test Suite': dev/tests.md

57 - 'Adding a new GHC version': dev/adding-new-ghc.md

58 - 'Coverage': dev/coverage.md

59 - 'ChangeLog': changelog.md