simple sample asciidoc

This demonstrates some simple things, such as the document headers,
attributes, sections, images, links and lists. I tried to add a table of
contents, but that isn't functioning yet. I intend to develop a template
for our wiki pages with this, so input or modifications are very
welcome.
This commit is contained in:
JosiahWI 2022-01-01 12:11:56 -06:00
parent 590352f1fe
commit be038452cf
No known key found for this signature in database
GPG Key ID: C7BB8573A4ABC4B9
2 changed files with 34 additions and 0 deletions

BIN
assets/pomegranate.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.3 MiB

34
templates/standard.adoc Normal file

@ -0,0 +1,34 @@
= Pomegranates
Author Minetest-Docs and Contributors
v1.0, 2022-01-01
:description: A sample template for using AsciiDoc.
:keywords: sample
// TODO: figure out why there is no table of contents!
:toc:
// Using an image directory is a good idea, for relative paths!
:imagesdir: ../assets
// URL references:
:url-docs: https://github.com/minetest/minetest_docs
This is a sample template of how a good AsciiDoc can be structured.
This pragraph describes the purpose of the document.
In this sample, an imaginary API
for producing pomegranates will be documented.
So without further ado, here is what we should see when we are done.
[#img-pomegranate]
.The Expected Result
image::pomegranate.png[Pomegranate]
== Pomegranate API Methods
* `plant_tree()`
* `grow_tree()`
* `spray_tree()`
== Source
You can contribute to the documentation at {url-docs}[our GitHub repository]!