Skip to content
This repository has been archived by the owner on Nov 23, 2024. It is now read-only.

Documentation generator #63

Open
jmackie opened this issue Jun 6, 2022 · 2 comments · May be fixed by #126
Open

Documentation generator #63

jmackie opened this issue Jun 6, 2022 · 2 comments · May be fixed by #126
Assignees
@jmackie
Labels
enhancement New feature or request
Milestone
0.0.4

Comments

@jmackie
Copy link
Member

jmackie commented Jun 6, 2022 

$ ditto make --docs

Add a Doc target to ditto-make and go from there.

Start with boring, static HTML docs and maybe make it more SPA like when we have a framework. It would be nice to have search functionality eventually, but that's not needed immediately.

Generate to a docs folder for consistency with GH pages.

Use ditto.css if possible. Note that purescript adds googlefonts to its generated docs.
@jmackie jmackie added the enhancement New feature or request label Jun 6, 2022
@jmackie jmackie added this to the 0.0.2 milestone Nov 1, 2022
@jmackie jmackie modified the milestones: 0.0.2, 0.0.3 Dec 9, 2022
@jmackie jmackie linked a pull request Jan 5, 2023 that will close this issue
Documentation generator 📝 #126
Draft
@jmackie
Copy link
Member Author

jmackie commented Jan 5, 2023

Actually, let's just generate markdown files to begin with. HTML, search, etc can come later.

@jmackie jmackie self-assigned this Jan 5, 2023
@jmackie
Copy link
Member Author

jmackie commented Jan 5, 2023 •
edited
Loading

Note that we could implement doc search via a wasm module 👀

Also see https://github.com/purescript/purescript-docs-search

@jmackie jmackie mentioned this issue Jan 7, 2023
Open
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@jmackie jmackie

Labels
enhancement New feature or request
Projects
Road to 0.1 🚙
Status: Todo
Milestone
0.0.4
Development

Successfully merging a pull request may close this issue.

Documentation generator 📝 ditto-lang/ditto
1 participant
@jmackie