Skip to content

Commit 6a20f11

Browse files
committed
Add mkdocs
1 parent bfb754f commit 6a20f11

File tree

4 files changed

+15
-15
lines changed

4 files changed

+15
-15
lines changed

docs/CNAME

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/index.md

Lines changed: 2 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,3 @@
1-
# Actual docs are coming soon. For now just enjoy README:
1+
# lapse-hs
22

3-
This is Lapse (my Lisp dialect) interpreter.
4-
5-
Examples: [here](https://github.com/ProggerX/lapse-hs/blob/master/example/)
6-
7-
## How to use this/try this
8-
- Go to [this page](https://github.com/ProggerX/lapse-hs/actions/workflows/build.yml)
9-
- Click on latest successful action run (or run from specific tag)
10-
- Find an "Artifacts" section and download version for your OS. (If you can't see download button, log in to your github account)
11-
- Unzip this artifact and you will get an executable of Lapse interpreter
12-
- To run some code, write this code in ".lp" file (in fact, extension does not matter) and run `<path-to-lapse-interpreter> <path-to-file>` command in command line
13-
- (You can find example files [here](https://github.com/ProggerX/lapse-hs/blob/master/example/))
14-
- Also, Lapse provides a clean REPL by `<path-to-lapse-interpreter>` command
3+
Hello, this is official [Lapse](https://github.com/ProggerX/lapse-hs) documentation. Lapse is my LISP dialect that was created in educational purposes only.

flake.nix

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,18 @@
77
{ flake-parts, nixpkgs, ... }@inputs:
88
let
99
hs-project =
10-
{ pkgs, isShell ? false }:
10+
{
11+
pkgs,
12+
isShell ? false,
13+
}:
1114
pkgs.haskellPackages.developPackage {
1215
root = ./.;
1316
returnShellEnv = isShell;
17+
modifier =
18+
drv:
19+
pkgs.haskell.lib.addBuildTools drv [
20+
pkgs.mkdocs
21+
];
1422
};
1523
in
1624
flake-parts.lib.mkFlake { inherit inputs; } {

mkdocs.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
site_name: Lapse Docs
2+
nav:
3+
- Lapse: index.md
4+
theme: readthedocs

0 commit comments

Comments
 (0)