forked from docs/team-docs
Justin W. Flory
af0119dc64
This is a first attempt at giving Fedora Documentation Writers a one- stop location to get started writing AsciiDoc. Instead of trying to rewrite existing documentation about AsciiDoc, I linked out to helpful resources maintained by the `asciidoctor.org` upstream. However, this commit does write new documentation about handy snippets to reuse in a Fedora-specific context. I also wrote a short guide on how to use reusable attributes, since I realize this is something I have done in many repositories I set up but never documented. Part of #8 to improve the new contributor experience to Fedora Documentation with AsciiDoc and Antora. Signed-off-by: Justin W. Flory <git@jwf.io>
18 lines
874 B
YAML
18 lines
874 B
YAML
# Name will be mostly visible in the URL. Treat it as an indentifier.
|
|
# Tip: If you want to use the local preview scripts that come with this repository, please change this value in the site.yml file as well. (under site/start_page)
|
|
name: fedora-docs
|
|
|
|
# Title will be visible on the page.
|
|
title: Fedora Docs Team
|
|
|
|
# If you don't plan to have multiple versions of the docs (for example, to document multiple versions of some software), you can ignore this field. Otherwise, change "master" to a specific version.
|
|
version: master
|
|
|
|
# We encourage you to name the index page as "index.adoc". If you absolutely have to use a different name, please reflect it here. You can ignore this field otherwise.
|
|
start_page: ROOT:index
|
|
|
|
# This lists all the menu definitions of your component.
|
|
nav:
|
|
- modules/ROOT/nav.adoc
|
|
- modules/contributing/nav.adoc
|
|
- modules/asciidoc-fedora/nav.adoc
|