mirror of
https://github.com/minetest/minetest_docs.git
synced 2024-10-04 00:43:07 +02:00
Small fixes
This commit is contained in:
parent
775203d8de
commit
96a5c6f7a9
@ -1,4 +1,5 @@
|
|||||||
= How to Write Good Documentation
|
= How to Write Good Documentation
|
||||||
|
include::include/config.adoc[]
|
||||||
|
|
||||||
This guide will attempt to help you avoid common documentation issues and help you get your point across as clearly as possible.
|
This guide will attempt to help you avoid common documentation issues and help you get your point across as clearly as possible.
|
||||||
|
|
||||||
@ -74,6 +75,7 @@ See link:templates/standard.adoc[standard template] for an example.
|
|||||||
* `config.adoc`: Global doc configuration.
|
* `config.adoc`: Global doc configuration.
|
||||||
* `types.adoc`: Lua types formatted as `type-name` linked to the Lua PIL. Example: `{type-string}`. +
|
* `types.adoc`: Lua types formatted as `type-name` linked to the Lua PIL. Example: `{type-string}`. +
|
||||||
All types should link somewhere at some point (cross-reference or outside).
|
All types should link somewhere at some point (cross-reference or outside).
|
||||||
|
* `footer.adoc`: Footer for every documentation page.
|
||||||
|
|
||||||
=== Functions
|
=== Functions
|
||||||
----
|
----
|
||||||
@ -121,3 +123,5 @@ All types should link somewhere at some point (cross-reference or outside).
|
|||||||
* `another_property:` `type`
|
* `another_property:` `type`
|
||||||
** A description.
|
** A description.
|
||||||
----
|
----
|
||||||
|
|
||||||
|
include::include/footer.adoc[]
|
||||||
|
@ -5,7 +5,7 @@ include::../include/types.adoc[]
|
|||||||
:keywords: standard, template
|
:keywords: standard, template
|
||||||
|
|
||||||
This is the standard template of how a good AsciiDoc should be structured.
|
This is the standard template of how a good AsciiDoc should be structured.
|
||||||
This pragraph describes the purpose of the document.
|
This paragraph describes the purpose of the document.
|
||||||
In this example, an imaginary API for a vehicle will be documented.
|
In this example, an imaginary API for a vehicle will be documented.
|
||||||
|
|
||||||
== Vehicle Properties
|
== Vehicle Properties
|
||||||
|
Loading…
Reference in New Issue
Block a user