-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Set up file structure for Antora (English language)
- Loading branch information
Showing
15 changed files
with
100 additions
and
18 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
# MANDATORY. Identifier of the document in URLs. Use '-' as word separator. | ||
# It can include letters, numbers and periods ( . ), but no other symbols. | ||
# Example: "my-awesome-doc" (quotes not needed) | ||
name: | ||
|
||
# MANDATORY. Title of the document as we want it to appear in docs.decidim.org | ||
# menus and navigation links. It's probably the same as README.adoc's | ||
# :_title: attribute. | ||
# Example: "My Awesome Document" (quotes not needed) | ||
title: | ||
|
||
# MANDATORY. "en", "es" or "ca". If more than one revision of the document is | ||
# going to be shown, then append the revision as it appears in README.adoc's | ||
# :revnumber: attribute, e.g., "en/0.1" (quotes not needed). | ||
version: en | ||
|
||
# MANDATORY. First page to show when we visit this document in docs.decidim.org. | ||
# It must be "ROOT:" followed by a file present in modules/ROOT/pages/. See | ||
# https://docs.antora.org/antora/1.0/page/page-id/ to understand how Antora's | ||
# Page Ids work. | ||
start_page: ROOT:introduction.adoc | ||
|
||
# MANDATORY. A list of Antora navigation files. You probably don't need to | ||
# change this field. See https://docs.antora.org/antora/1.0/navigation/ | ||
# if you want to learn more about it. | ||
nav: | ||
- modules/ROOT/nav.adoc |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
:attachmentsdir: {moduledir}/assets/attachments | ||
:examplesdir: {moduledir}/examples | ||
:imagesdir: {moduledir}/assets/images | ||
:partialsdir: {moduledir}/pages/_partials |
File renamed without changes.
Empty file.
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
// Add to the following list cross references to all the contents you want | ||
// listed in the navigation menu for this document. | ||
.Contents | ||
* xref:introduction.adoc[Introduction] | ||
* Second section | ||
** Subsection A | ||
** Subsection B | ||
* Third section | ||
.Resources | ||
* xref:metadata.adoc[Metadata] | ||
* xref:contributing.adoc[Authorship criteria and how to contribute to this document] | ||
* xref:single-page.adoc[Single page view] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
:moduledir: .. | ||
include::{moduledir}/_attributes.adoc[] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
= Authorship criteria and how to contribute to this document | ||
ifndef::env-site,env-github[] | ||
include::_attributes.adoc[] | ||
endif::[] | ||
|
||
include::{partialsdir}/README.adoc[tag=metadata] | ||
|
||
include::{partialsdir}/CONTRIBUTING.adoc[tag=contents] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
= Introduction | ||
ifndef::env-site,env-github[] | ||
include::_attributes.adoc[] | ||
endif::[] | ||
|
||
include::{partialsdir}/README.adoc[tag=metadata] | ||
|
||
// Start writing here |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
= Metadata | ||
ifndef::env-site,env-github[] | ||
include::_attributes.adoc[] | ||
endif::[] | ||
|
||
include::{partialsdir}/README.adoc[tag=metadata] | ||
|
||
include::{partialsdir}/README.adoc[tag=metadata-table] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters