Topics-rules

In Arqiva, markdown files are called topics. Creating a topic is to create a markdown file. The topics are placed under the topics directory.

Arqiva comes with a naming convention that must be followed while creating topic files and folders:

• The folder and file names must have two leading digits followed by an underscore character: _
• The topic files must have the .md extension
• The topic file and folder names must only have one underscore character, the underscore after the two leading digits.

Valid topic file and folder names examples

    01_hello-world.md
    02_metting-arqiva.md
    03_Entering-another-galaxy.md
    04_more-topics
    05_example-topics

Invalid topic file names examples

    01_hello_world.md //multiple underscores not allowed
    002_metting_arqiva.md //three leading zeros not allowed
    03_Entering-another-galaxy.html //file extension must be .md

Leading-digits

The two-leading digits are used to determine the position of each topic in the topics tree. That two digits are used to determine the topics sequence : next and previous. Make sure the numbers are showing the correct order.

Web URLS

This topic file:

    topics/01-examples/01-first-topic.md

Will be mapped to:

    topics/examples/first-topic.html