mkdocs.yml · haskell.nix

git.iko.soy/haskell.nix

on 147cf21 help sign in

haskell.nix/mkdocs.yml

47 lines 1.6 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

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 - toc:

20 permalink: true

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

23# right now is 0.17.5

24pages:

25 - 'Introduction': index.md

26 - 'Architecture': architecture.md

27 - 'User Guide':

28 - 'General': user-guide.md

29 - 'Creating Nix builds for your projects': user-guide/projects.md

30 - 'Stack Projects': user-guide/stack-projects.md

31 - 'Cabal Projects': user-guide/cabal-projects.md

32 - 'How to create a development environment': user-guide/development.md

33 - 'How to cross-compile your project': user-guide/cross-compilation.md

34 - 'Reference':

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

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

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

38 - 'Templates / Abstraction':

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

40 - 'Dev Notes':

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

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

43 - 'Mapping non-Haskell dependencies to Nixpkgs': dev/pkg-map.md

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

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

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

47 - 'ChangeLog': changelog.md