nobodywasishere/crystaldoc.info

Crystal Shards API Documentation Hosting

crystaldoc.info's Issues

Move from firejail to docker for building docs

Docker is what docs.rs uses, and it would give a lot more flexibility towards the environment docs are generated in, allowing for using older versions of the docs generator, adding custom libs, better security, and easier setup.

docs.rs uses rustwide, a secure execution environment built on Docker. A similar shard should be developed for Crystal for safe execution.

Add a `latest` route for permalinking

If I were to create a link to the docs from a blog post or static site, it links to a specific version. Unlike the Crystal stdlib docs, I don't see a way to link to the newest version of the docs, instead of a specific static version. This could be problematic if I were to link to them from a static website.

Add support for Fossil and Mercurial

This may require minor refactoring, but all we need to figure out to use these tools is:

• check if a given url is a valid repository of that vcs type
• get a list of all the tags and their hashes without cloning
• get the name and hash of the main branch without cloning
• cloning the repository
• forcefully checking out a specific tag

How repos are parsed will also have to be changed, as the largest fossil host doesn't follow the domain.tld/user/proj format.

The current git functionality all lives entirely within CrystalDoc::VCS

Example Crystal Fossil repo for testing:
https://chiselapp.com/user/MistressRemilia/repository/remiaudio/index

If anyone knows of an example mercurial one please let me know!

Bug in rendering doc for lexbor

Hello! Thanks for creating and hosting this fantastic tool :D

I found a page in the lexbor documentation that seems to be rendering incorrectly.

Page: https://crystaldoc.info/github/kostya/lexbor/v3.1.2/Lexbor/Node.html

What I see:

I'm not seeing any missing css or failed network calls, so not sure what the culprit is.

Add `.crystaldoc.yml` config file for configuring docs generator

Add a .crystaldoc.yml file that lists config options for crystaldoc, namely what apt packages should be installed before executing, and what commands should be executed before building docs. This would allow GTK4 binding docs to be built

https://forum.crystal-lang.org/t/crystaldoc-info-hosted-shard-api-documentation/6018/5?u=nobodywasishere
https://hugopl.github.io/gtk4.cr/

Add README Badges

https://shields.io/

There could be a link on every doc page at the bottom Copy README Badge, or the format for specifying them could be consistent. I'm unsure if these should just be pure links, or be dynamic and return the latest docs version.

Something like this: