Use lispkit.org to document *everything*

[AeroNotix]

I have lispkit.org so I want to put it to good use

I would like:

• List of features and their configuration
• List of available commands
• Video tutorials
• Internal source documentation

How to accomplish:

• I will put forth a VPS to use.
• I will maintain the VPS.
• The site must be a statically generated set of pages
• The site's source must be a part of this repo.

Questions:

• What to use for this?
  • The Lisp docstring->html generators output awful HTML, to be frank. I've used Sphinx in the past with great success as it allows a mixture of both free form text and automatically parsed docstrings. Does such a thing exist for Common Lisp or am I right in thinking it does not.

[ralt]

If all you need is a static site generator, why not use github's Jekyll? Putting the site source in the repo will automatically generate the HTML and the hosting is taken care of.

[AeroNotix]

I want something to generate HTML from source code docstrings too. Jekyll is a great idea though, probably will end up with something like that.

[jorams]

As far as I know such a thing doesn't exist. I wish it did. Shinmera's Staple allows you to use a custom template, but I believe that's about as far as you'll get with any of the current docstring-html generators. Perhaps something like that could be integrated into the site generation process though.

[AeroNotix]

I looked at Staple and found it to be very lacking in the built-in templates and styles. I don't want something that I have to write loads of CSS to make it look pretty :)

On Sat Dec 06 2014 at 2:32:25 PM Joram Schrijver notifications@github.com wrote:

As far as I know such a thing doesn't exist. I wish it did. Shinmera's Staple https://github.com/Shinmera/staple allows you to use a custom template, but I believe that's about as far as you'll get with any of the current docstring-html generators. Perhaps something like that could be integrated into the site generation process though.

— Reply to this email directly or view it on GitHub https://github.com/AeroNotix/lispkit/issues/47#issuecomment-65897023.

[ralt]

Can we take inspiration in quickdocs? Le 6 déc. 2014 14:37, "Aaron France" notifications@github.com a écrit :

I looked at Staple and found it to be very lacking in the built-in templates and styles. I don't want something that I have to write loads of CSS to make it look pretty :)

On Sat Dec 06 2014 at 2:32:25 PM Joram Schrijver notifications@github.com

wrote:

As far as I know such a thing doesn't exist. I wish it did. Shinmera's Staple https://github.com/Shinmera/staple allows you to use a custom template, but I believe that's about as far as you'll get with any of the current docstring-html generators. Perhaps something like that could be integrated into the site generation process though.

— Reply to this email directly or view it on GitHub https://github.com/AeroNotix/lispkit/issues/47#issuecomment-65897023.

— Reply to this email directly or view it on GitHub https://github.com/AeroNotix/lispkit/issues/47#issuecomment-65897193.

[AeroNotix]

Yeah, quickdocs is really nice.

On Sat Dec 06 2014 at 2:47:07 PM Florian Margaine notifications@github.com wrote:

Can we take inspiration in quickdocs? Le 6 déc. 2014 14:37, "Aaron France" notifications@github.com a écrit :

I looked at Staple and found it to be very lacking in the built-in templates and styles. I don't want something that I have to write loads of CSS to make it look pretty :)

On Sat Dec 06 2014 at 2:32:25 PM Joram Schrijver < notifications@github.com>

wrote:

As far as I know such a thing doesn't exist. I wish it did. Shinmera's Staple https://github.com/Shinmera/staple allows you to use a custom template, but I believe that's about as far as you'll get with any of the current docstring-html generators. Perhaps something like that could be integrated into the site generation process though.

— Reply to this email directly or view it on GitHub https://github.com/AeroNotix/lispkit/issues/47#issuecomment-65897023.

— Reply to this email directly or view it on GitHub https://github.com/AeroNotix/lispkit/issues/47#issuecomment-65897193.

— Reply to this email directly or view it on GitHub https://github.com/AeroNotix/lispkit/issues/47#issuecomment-65897435.

[vindarel]

Hello there, now there's https://github.com/CommonDoc/codex, a documentation system for Common Lisp. I tried it and it works as advertised.

https://commondoc.github.io/codex/docs/tutorial.html

[AeroNotix]

Take a stab at it if you fancy.