diff --git a/404.html b/404.html index 564a569..24655ee 100644 --- a/404.html +++ b/404.html @@ -1 +1 @@ -404 - Page not found! - apos-docs

404 - Page not found!

\ No newline at end of file +404 - Page not found! - apos-docs

404 - Page not found!

\ No newline at end of file diff --git a/a/index.html b/a/index.html index 96b6df1..f0fe760 100644 --- a/a/index.html +++ b/a/index.html @@ -1 +1 @@ -a - apos-docs

a

Outbound / Other:

Relative

Absolute

Edit this page on GitHub
\ No newline at end of file +a - apos-docs

a

Outbound / Other:

Relative

Absolute

Edit this page on GitHub
\ No newline at end of file diff --git a/best-practices/index.html b/best-practices/index.html index 8c79551..ddb7a0a 100644 --- a/best-practices/index.html +++ b/best-practices/index.html @@ -1,4 +1,4 @@ -Best practices - apos-docs

Best practices

This page will document my recommended best practices. Note that the first rule of best practices is that there are no best practices.

File name

File names should use kebab-case such as best-practices.md.

Title

A page’s title should be at the top of a markdown file. Only capitalize the first letter. It is preceded by a single # and a space.

# Best practices
+Best practices - apos-docs
  
Best practices
This page will document my recommended best practices. Note that the first rule of best practices is that there are no best practices.
File name
File names should use kebab-case such as best-practices.md.
Title
A page’s title should be at the top of a markdown file. Only capitalize the first letter. It is preceded by a single # and a space.
# Best practices
 
Description
Each page should have a description. It should directly follow the title. It should be shorter than 160 characters.
# Best practices
 This page will document my recommended best practices. Note that the first rule of best practices is that there are no best practices.
 
Edit this page on GitHub

\ No newline at end of file
diff --git a/design-choices/index.html b/design-choices/index.html
index 36d3997..3fe6266 100644
--- a/design-choices/index.html
+++ b/design-choices/index.html
@@ -1 +1 @@
-Design choices - apos-docs
  
Design choices
High level overview for the apos-docs design decisions.
Markdown
  • The markdown should be readable by itself from GitHub. This means that links must work in the context of the repository and be rewritten for the static site.
  • Avoid custom markdown syntax unless absolutely necessary.
  • The page’s first h1 tag will be used as the page title. The site name will be appended to it.
  • The page’s first p tag will be used as the page description.
  • Pages that have multiple headings will have a table of content generated.
  • Each page in the generated site will include an edit link that points to the same page in the GitHub repository.
Images
  • Support jpg, png, gif
  • Links to images must work in the context of the repository and be rewritten for the static site.
Routing
  • README.md files become index.html.
  • Other pages such as page.md become page/index.html.
Stored in docs/_data/nav.yml and contains:
  • Nested list of links to navigate through the docs’ pages.
  • List of social media links.
Edit this page on GitHub

\ No newline at end of file
+Design choices - apos-docs
  
Design choices
High level overview for the apos-docs design decisions.
Markdown
  • The markdown should be readable by itself from GitHub. This means that links must work in the context of the repository and be rewritten for the static site.
  • Avoid custom markdown syntax unless absolutely necessary.
  • The page’s first h1 tag will be used as the page title. The site name will be appended to it.
  • The page’s first p tag will be used as the page description.
  • Pages that have multiple headings will have a table of content generated.
  • Each page in the generated site will include an edit link that points to the same page in the GitHub repository.
Images
  • Support jpg, png, gif
  • Links to images must work in the context of the repository and be rewritten for the static site.
Routing
  • README.md files become index.html.
  • Other pages such as page.md become page/index.html.
Stored in docs/_data/nav.yml and contains:
  • Nested list of links to navigate through the docs’ pages.
  • List of social media links.
Edit this page on GitHub

\ No newline at end of file
diff --git a/getting-started/index.html b/getting-started/index.html
index d459d0b..fba00b9 100644
--- a/getting-started/index.html
+++ b/getting-started/index.html
@@ -1,4 +1,4 @@
-Getting started - apos-docs
  
Getting started
Quick guide to get you started with apos-docs.
Setup
In your GitHub repository’s root, you will need the following:
README.md
+Getting started - apos-docs
  
Getting started
Quick guide to get you started with apos-docs.
Setup
In your GitHub repository’s root, you will need the following:
README.md
 docs/getting-started.md
 docs/img/Icon.png
 docs/_data/nav.yml
diff --git a/hello-world/index.html b/hello-world/index.html
index a22dc31..bc55a5b 100644
--- a/hello-world/index.html
+++ b/hello-world/index.html
@@ -1 +1 @@
-Hello - apos-docs
  
Hello
Just a hello.
World
world!
Edit this page on GitHub

\ No newline at end of file
+Hello - apos-docs
  
Hello
Just a hello.
World
world!
Edit this page on GitHub

\ No newline at end of file
diff --git a/index.html b/index.html
index 253418c..6aa422a 100644
--- a/index.html
+++ b/index.html
@@ -1 +1 @@
-apos-docs
  
apos-docs
Documentation static site generator built with Eleventy.
It should work out of the box with minimal configuration. This is meant to be used in combination with GitHub Pages. The final output should work with JavaScript disabled.
npmNuGet
Description
Takes in a docs directory along with your main README.md. Compiles the output into an apos-docs/_site directory. Adds the content of the apos-docs/_site directory to a gh-pages branch. The documentation for your repository will be available at [username].github.io/[repository name].
Documentation
Tech Stack
Used by
Edit this page on GitHub

\ No newline at end of file
+apos-docs
  
apos-docs
Documentation static site generator built with Eleventy.
It should work out of the box with minimal configuration. This is meant to be used in combination with GitHub Pages. The final output should work with JavaScript disabled.
npmNuGet
Description
Takes in a docs directory along with your main README.md. Compiles the output into an apos-docs/_site directory. Adds the content of the apos-docs/_site directory to a gh-pages branch. The documentation for your repository will be available at [username].github.io/[repository name].
Documentation
Tech Stack
Used by
Edit this page on GitHub

\ No newline at end of file
diff --git a/markdown/index.html b/markdown/index.html
index f80fc72..9201f54 100644
--- a/markdown/index.html
+++ b/markdown/index.html
@@ -1,4 +1,4 @@
-Markdown showcase - apos-docs
  
Markdown showcase
This page shows a preview of the markdown features that are supported.
h1 Heading 😎
h2 Heading
h3 Heading
h4 Heading
h5 Heading
h6 Heading
Horizontal Rules
Typographic replacements
Enable typographer option to see result.
© © ® ® ™ ™ (p) (P) ±
test… test… test… test?.. test!..
!!! ??? , – —
“Smartypants, double quotes” and ‘single quotes’
Emphasis
This is bold text
This is bold text
This is italic text
This is italic text
Strikethrough
Blockquotes
Blockquotes can also be nested…
…by using additional greater-than signs right next to each other…
…or with spaces between arrows.
Lists
Unordered
  • Create a list by starting a line with +, -, or *
  • Sub-lists are made by indenting 2 spaces:
    • Marker character change forces new list start:
      • Ac tristique libero volutpat at
      • Facilisis in pretium nisl aliquet
      • Nulla volutpat aliquam velit
  • Very easy!
Ordered
  1. Lorem ipsum dolor sit amet
  2. Consectetur adipiscing elit
  3. Integer molestie lorem at massa
  4. You can use sequential numbers…
  5. …or keep all the numbers as 1.
Start numbering with offset:
  1. foo
  2. bar
Code
Inline code
Indented code
// Some comments
line 1 of code
line 2 of code
line 3 of code
Block code “fences”
Sample text here...
+Markdown showcase - apos-docs
  
Markdown showcase
This page shows a preview of the markdown features that are supported.
h1 Heading 😎
h2 Heading
h3 Heading
h4 Heading
h5 Heading
h6 Heading
Horizontal Rules
Typographic replacements
Enable typographer option to see result.
© © ® ® ™ ™ (p) (P) ±
test… test… test… test?.. test!..
!!! ??? , – —
“Smartypants, double quotes” and ‘single quotes’
Emphasis
This is bold text
This is bold text
This is italic text
This is italic text
Strikethrough
Blockquotes
Blockquotes can also be nested…
…by using additional greater-than signs right next to each other…
…or with spaces between arrows.
Lists
Unordered
  • Create a list by starting a line with +, -, or *
  • Sub-lists are made by indenting 2 spaces:
    • Marker character change forces new list start:
      • Ac tristique libero volutpat at
      • Facilisis in pretium nisl aliquet
      • Nulla volutpat aliquam velit
  • Very easy!
Ordered
  1. Lorem ipsum dolor sit amet
  2. Consectetur adipiscing elit
  3. Integer molestie lorem at massa
  4. You can use sequential numbers…
  5. …or keep all the numbers as 1.
Start numbering with offset:
  1. foo
  2. bar
Code
Inline code
Indented code
// Some comments
line 1 of code
line 2 of code
line 3 of code
Block code “fences”
Sample text here...
 
Syntax highlighting
var foo = function (bar) {
   return bar++;
 };
diff --git a/other-page/index.html b/other-page/index.html
index c3f89a2..b5fd359 100644
--- a/other-page/index.html
+++ b/other-page/index.html
@@ -1 +1 @@
-Other page - apos-docs
  
Other page
This is an example page that shouldn’t have any table of content.
Edit this page on GitHub

\ No newline at end of file
+Other page - apos-docs
  
Other page
This is an example page that shouldn’t have any table of content.
Edit this page on GitHub

\ No newline at end of file