Skip to content

Host site as github repo of md files? #192

Open
@shaunlebron

Description

@shaunlebron

I’d like to populate the docfiles with generated content to avoid hosting a separate site.

Embed clojure code inside <!-- clj (...) -> tags to generate content.

## Summary
...

## Details
...

## Examples
...

## Source

<!-- clj (cljs-api/get-source *entry*)-->
...
<!-- clj -->

And I’d like a way to run something like clj -M docgen.clj <docfile> to update it using info from cljs-api.edn maybe.

Migration plan

  • Generate cljs-api.edn without docfiles
  • Generate *.clj.md files from original docfiles (“ejecting”)
  • Have newly detected symbols generate *.clj.md stub files.
  • Replace doc: links with relative md links
  • Create a new process for updating *.clj.md files, only by using embedded clojure calls to helper functions using cljs-api.edn
  • Allow insertion of new functions
  • Eventually use this system to document clojure functions

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions