clojure / clojure/clojure-site

Make documentation available in a static offline format

Open
#637 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

backlog
Dominant language
HTML
Stars
259
Forks
275
PR merge metrics
No merged PRs in 30d

Description

I am interested in using the Clojure language documentation offline. Would it be possible to provide a static HTML version of the reference material listed below (and any other relevant materials) for offline usage? Languages such as Python provide static/offline documentation of the language and core libraries. Having access to documentation without a persistent internet connection would be beneficial for clojure users.

Additional formats such as PDF, EPUB, etc would also be a very nice thing to have on top of a static HTML version.

I opened this ticket because I was unable to find a downloadable version of the language documentation. If downloadable docs do exist, please link them below for future seekers and close this ticket.

thank you !

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the linked Guides, Reference, and API documentation on clojure.org, then inspect how this repository currently publishes those materials. Define a static offline HTML output covering those sections; PDF and EPUB are optional additions requested by the issue. Done means the documentation can be downloaded and used without a persistent internet connection.

Written by the indexing model from the issue text.

Assessment

Tech stack
html
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.