Skip to content
Snippets Groups Projects
Commit e35e11de authored by Sean Madsen's avatar Sean Madsen
Browse files

Make URLs more hackable

Close #86
parent ad286d14
Branches
No related tags found
No related merge requests found
File moved
File moved
......@@ -36,6 +36,10 @@ option (when possible) is helpful to some readers.
Don't use terms like "previous chapter", etc. because we may add or re-arrange
chapters in the future. Instead, use a hyperlink to the chapter.
### Hackable URLs
When you organize several markdown files into one folder, it's good practice to include an `index.md` file within the folder and list this index file *first* in the list of pages within the folder in `mkdocs.yml`. This creates a "general" page which follows the same URL structure as the other pages in the folder but allows readers to hack the URL more easily.
### Headings
The first heading in a chapter should be Heading 1. All others should be
......
File moved
File moved
......@@ -22,7 +22,7 @@ pages:
# Submitting a Patch: /core/patches.md
# Verifying a Bug Fix: /core/verifying.md
- Extensions Development:
- Basics: extensions/basics.md
- Basics: extensions/index.md
- civix: extensions/civix.md
# Creating Pages: extensions/create-page.md
# Storing Configuration: extensions/config.md
......@@ -56,7 +56,7 @@ pages:
# CiviReport: /reference/civireport.md
# Payment Processing: /reference/payment.md
- API:
- APIv3 Intro: api/general.md
- APIv3 Intro: api/index.md
- APIv3 Usage: api/usage.md
- APIv3 Actions: api/actions.md
- APIv3 Parameters: api/params.md
......@@ -64,7 +64,7 @@ pages:
- APIv3 Chaining: api/chaining.md
# APIv3 Changes: api/changes.md
- Hooks:
- Using hooks: hooks.md
- Using hooks: hooks/index.md
- Setup:
- Hooks with Symfony: hooks/setup/symfony.md
- Hooks with Joomla: hooks/setup/joomla.md
......@@ -187,7 +187,7 @@ pages:
- hook_civirules_alter_trigger_data: hooks/hook_civirules_alter_trigger_data.md
- hook_civirules_logger: hooks/hook_civirules_logger.md
- Documentation:
- Writing Documentation: documentation.md
- Writing Documentation: documentation/index.md
- Documenting Extensions: documentation/extensions.md
- Markdown: documentation/markdown.md
- Style Guide: documentation/style-guide.md
......
dev-tools/debugging basics/debugging
extend-stages extensions/lifecycle
markdownrules documentation/markdown
best-practices/documentation-style-guide documentation/style-guide
\ No newline at end of file
best-practices/documentation-style-guide documentation/style-guide
extensions/basics extensions
api/general api
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment