https://github.com/wavejumper/codoxify

Generate Clojure documentation for docsify
https://github.com/wavejumper/codoxify

api clojure clojurescript codox docsify documentation documentation-generator markdown

Last synced: about 2 months ago
JSON representation

Generate Clojure documentation for docsify

• Host: GitHub
• URL: https://github.com/wavejumper/codoxify
• Owner: wavejumper
• License: mit
• Created: 2020-05-27T11:44:12.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2020-08-02T12:01:51.000Z (about 4 years ago)
• Last Synced: 2024-07-10T14:07:16.391Z (2 months ago)
• Topics: api, clojure, clojurescript, codox, docsify, documentation, documentation-generator, markdown
• Language: Clojure
• Homepage: https://tscrowley.dev/codoxify/
• Size: 74.2 KB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-docsify - codoxify - Generate Clojure documentation for docsify. (Showcase)

README

        
[![Clojars Project](https://img.shields.io/clojars/v/wavejumper/codoxify.svg)](https://clojars.org/wavejumper/codoxify)

# codoxify

Use [codox](https://github.com/weavejester/codox) to build Clojure documentation for [docsify](https://github.com/docsifyjs/docsify)

## Usage

Follow the installation instructions and usage for [codox](https://github.com/weavejester/codox)

Add `codoxify` as a dependency to your `project.clj`:

```clojure

:profiles {:codox {:dependencies [[wavejumper/codoxify "1.0.2"]]

                   :plugins      [[lein-codox "0.10.7"]]

                   :codox        {:writer codoxify.writer/write-docs}}}

```

Without any extra configuration, this will compile your documentation to `target/docs`

```

npx docsify init ./target/docs

npx docsify serve ./target/docs

lein with-profiles +codox codox

```

### docsify configuration

Edit `./target/docs/index.html` and configure docsify as such:

```javascript

window.$docsify = {

  loadSidebar: true,

  subMaxLevel: 3, // important

  loadNavbar: true,

  alias: {

    'sidebar.md': '/_sidebar.md' //important

  }

}

```

## Example

An example of the [ring](https://github.com/ring-clojure/ring) project generated with codoxify can be found [here](https://tscrowley.dev/codoxify/)