Rewrite our documentation index
We're going to flesh this out a lot in the future, but this'll have to do for now.
This commit is contained in:
parent
cb8135a0d1
commit
f9f94b8304
|
@ -4,6 +4,7 @@
|
||||||
/build
|
/build
|
||||||
/out
|
/out
|
||||||
/doc/**/*.html
|
/doc/**/*.html
|
||||||
|
/doc/index.json
|
||||||
|
|
||||||
# Runtime directories
|
# Runtime directories
|
||||||
/run
|
/run
|
||||||
|
|
18
doc/index.md
18
doc/index.md
|
@ -1,13 +1,11 @@
|
||||||
# CC: Tweaked
|
# ![CC: Tweaked](logo.png) [![Download CC: Tweaked on CurseForge](http://cf.way2muchnoise.eu/title/cc-tweaked.svg)](https://minecraft.curseforge.com/projects/cc-tweaked "Download CC: Tweaked on CurseForge")
|
||||||
|
|
||||||
This is a small website to test documentation generation from Lua source code.
|
CC: Tweaked is a fork of [ComputerCraft], adding programmable computers, turtles and more to Minecraft.
|
||||||
|
|
||||||
This is still very much in the proof-of-concept stage. We've rolled own own documentation
|
This website contains documentation for all Lua libraries and APIs from the latest version of CC: Tweaked. This
|
||||||
generation tool, and there's a couple of missing features. Furthermore, Java-based APIs
|
documentation is still in development, so will most likely be incomplete. If you've found something you think is wrong,
|
||||||
(such as Lua builtins, or @{os}) are not documented.
|
or would like to help out [please get in touch on GitHub][gh].
|
||||||
|
|
||||||
For more information, please check out [the GitHub issue][gh_issue] and [the
|
[bug]: https://github.com/SquidDev-CC/CC-Tweaked/issues/new/choose
|
||||||
documented source][gh_branch].
|
[computercraft]: https://github.com/dan200/ComputerCraft "ComputerCraft on GitHub"
|
||||||
|
[gh]: https://github.com/SquidDev-CC/CC-Tweaked "CC:Tweaked on GitHub"
|
||||||
[gh_issue]: https://github.com/SquidDev-CC/CC-Tweaked/issues/133
|
|
||||||
[gh_branch]: https://github.com/SquidDev-CC/CC-Tweaked/tree/feature/doc-gen
|
|
||||||
|
|
Loading…
Reference in New Issue