11 |
22 |
23 | {{ content }}
24 |
25 |
26 |
10 |
27 | {% include "footer.jingoo" %}
28 |
29 |
30 |
--------------------------------------------------------------------------------
/bin/main.ml:
--------------------------------------------------------------------------------
1 | open Camyll
2 | open Cmdliner
3 |
4 | let guard f x =
5 | try Ok (f x) with
6 | | Failure e -> Error e
7 | | Invalid_argument e -> Error e
8 | | Sys_error e -> Error e
9 | | Unix.Unix_error (e, cmd, "") -> Error (cmd ^ ": " ^ Unix.error_message e)
10 | | Unix.Unix_error (e, cmd, p) ->
11 | Error (cmd ^ " " ^ p ^ ": " ^ Unix.error_message e)
12 |
13 | let build_cmd =
14 | let doc = "build the site" in
15 | Cmd.v (Cmd.info "build" ~doc)
16 | Term.(term_result' (const (guard Build.build) $ const ()))
17 |
18 | let serve_cmd =
19 | let doc = "serve the site" in
20 | let port =
21 | let inf = Arg.info ~docv:"PORT" [ "port" ] in
22 | Arg.(value & opt int 8080 inf)
23 | in
24 | Cmd.v (Cmd.info "serve" ~doc)
25 | Term.(term_result' (const (guard Serve.serve) $ port))
26 |
27 | let () =
28 | let doc = "static site generator" in
29 | let cmds = [ build_cmd; serve_cmd ] in
30 | exit Cmd.(eval (group (Cmd.info "camyll" ~doc) cmds))
31 |
--------------------------------------------------------------------------------
/web/content/docs/index.md:
--------------------------------------------------------------------------------
1 | +++
2 | title = "Documentation"
3 | layout = "docs.jingoo"
4 | +++
5 |
6 | # Documentation
7 |
8 | ## Installation
9 |
10 | The easiest way to install Camyll is through Opam.
11 |
12 | ```
13 | opam install camyll
14 | ```
15 |
16 | ## Directory Structure
17 |
18 | A site directory should look like this:
19 |
20 | ```
21 | .
22 | ├── config.toml
23 | ├── content/
24 | ├── grammars/
25 | ├── includes/
26 | ├── layouts/
27 | └── theme.tmTheme
28 | ```
29 |
30 | - `config.toml` is the configuration file.
31 | - `content/` is a directory that contains the site content to be transformed.
32 | - `grammars/` is a directory that contains the TextMate grammars used for
33 | syntax highlighting.
34 | - `includes/` is a directory that contains partial templates that may be
35 | included in other templates.
36 | - `layouts/` is a directory that contains whole-page templates.
37 | - `theme.tmTheme` is a file that contains the TextMate theme used for syntax
38 | highlighting.
39 |
--------------------------------------------------------------------------------
/test/unit/test_url.ml:
--------------------------------------------------------------------------------
1 | open Camyll.Url
2 |
3 | let () =
4 | assert (relativize ~src:"/posts/first-post/" ~dest:"/posts/" = "../");
5 | assert (relativize ~src:"/posts/" ~dest:"/posts/first-post/" = "first-post/");
6 | assert (
7 | relativize ~src:"/posts/first-post/" ~dest:"/posts/second-post/"
8 | = "../second-post/");
9 | assert (
10 | relativize ~src:"/posts/first-post/" ~dest:"posts/second-post/"
11 | = "posts/second-post/");
12 | assert (relativize ~src:"/posts/first-post/" ~dest:"" = "");
13 | assert (relativize ~src:"/" ~dest:"/docs/index.html" = "docs/index.html");
14 | assert (
15 | relativize ~src:"/docs/index.html" ~dest:"/docs/configuration.html"
16 | = "configuration.html");
17 | assert (relativize ~src:"/docs/index.html" ~dest:"/site.css" = "../site.css");
18 | assert (relativize ~src:"/posts/second-post.html" ~dest:"/posts/" = "./");
19 | assert (
20 | relativize ~src:"/posts/third-post.html" ~dest:"/posts/third-post.html"
21 | = "third-post.html")
22 |
--------------------------------------------------------------------------------
/.github/workflows/test.yaml:
--------------------------------------------------------------------------------
1 | name: install-test
2 |
3 | on: [push, pull_request]
4 |
5 | jobs:
6 | build:
7 | runs-on: ubuntu-24.04
8 | strategy:
9 | matrix:
10 | ocaml-compiler:
11 | - 4.14.x
12 | - 5.3.x
13 | steps:
14 | - uses: actions/checkout@v4
15 | - uses: ocaml/setup-ocaml@v3
16 | with:
17 | ocaml-compiler: ${{ matrix.ocaml-compiler }}
18 | - name: Update path
19 | run: echo "$HOME/.local/bin" >> $GITHUB_PATH
20 |
21 | - name: Build
22 | run: |
23 | eval $(opam env)
24 | sudo apt-get install agda-bin
25 | sudo apt-get install libonig-dev
26 | pip3 install agda-pkg
27 | echo "$HOME/.local/bin" >> $GITHUB_PATH
28 | apkg init
29 | apkg install standard-library --version v1.1 --yes
30 | opam install . --with-test
31 | opam install ocamlformat
32 | dune fmt
33 | cd example
34 | camyll build
35 | cd ../web
36 | camyll build
37 |
--------------------------------------------------------------------------------
/web/content/index.html:
--------------------------------------------------------------------------------
1 | +++
2 | title = "Camyll"
3 | layout = "home.jingoo"
4 | +++
5 |
6 |
7 | 
8 |
9 |
10 |
8 |
11 |
33 |
--------------------------------------------------------------------------------
/dune-project:
--------------------------------------------------------------------------------
1 | (lang dune 2.7)
2 | (name camyll)
3 | (generate_opam_files true)
4 |
5 | (license MIT)
6 | (authors "Alan Hu
12 |
32 |
13 |
16 | Markdown
14 | Camyll converts files ending in.md from Markdown to HTML.
15 |
17 |
21 | Literate Agda
18 | Camyll recognizes files ending in.lagda.md as Literate Agda
19 | files and invokes the Agda compiler to preprocess the Agda code blocks.
20 |
22 |
27 | Syntax Highlighting
23 | Instead of supporting a fixed set of languages, Camyll lets the user 24 | provide TextMate grammars in the site directory for any desired language. 25 | Camyll uses TextMate themes to assign colors to tokens. 26 |
28 |
31 |