Skip to content

Commit 07516ef

Browse files
author
Micah Godbolt
committed
Swithced to mkdocs
1 parent 79be534 commit 07516ef

File tree

13 files changed

+25
-172
lines changed

13 files changed

+25
-172
lines changed

Gruntfile.js

Lines changed: 0 additions & 61 deletions
This file was deleted.

README.md

Lines changed: 12 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,17 @@
1-
# metalsmith-starter
1+
# Welcome to MkDocs
22

3+
For full documentation visit [mkdocs.org](http://mkdocs.org).
34

4-
## Install dependencies
5-
6-
`$ npm install`
7-
8-
## One time build of docs
9-
10-
`$ npm run build`
11-
12-
## Build docs, serve, watch for changes
13-
14-
`$ npm run serve`
15-
16-
Docs will be viewable at [http://localhost:8080](http://localhost:8080)
17-
5+
## Commands
186

7+
* `mkdocs new [dir-name]` - Create a new project.
8+
* `mkdocs serve` - Start the live-reloading docs server.
9+
* `mkdocs build` - Build the documentation site.
10+
* `mkdocs help` - Print this help message.
1911

12+
## Project layout
2013

14+
mkdocs.yml # The configuration file.
15+
docs/
16+
index.md # The documentation homepage.
17+
... # Other markdown pages, images and other files.

docs/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Welcome to Patter Builder

src/docs/pattern_builder.md renamed to docs/pattern_builder.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,8 @@ title: Pattern Builder
3636

3737

3838
Install Options: (NEEDS CLEANUP)
39-
install patternbuilder module, composer install in the patternbuilder module folder + install composer_manager
39+
install patternbuilder module, composer install in the patternbuilder module folder + install composer_manager
4040

41-
OR
41+
OR
4242

4343
install patternbuilder module, clone patternbuilder-lib-php into libraries and then composer install from there
File renamed without changes.
File renamed without changes.
File renamed without changes.

layouts/page.html

Lines changed: 0 additions & 22 deletions
This file was deleted.

metalsmith.js

Lines changed: 0 additions & 36 deletions
This file was deleted.

mkdocs.yml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
site_name: Pattern Builder
2+
3+
pages:
4+
- Home: index.md
5+
- Pattern Builder Module: pattern_builder.md
6+
- Pattern Builder Library: pattern_builder_library.md
7+
- Pattern Builder Importer: pattern_builder_importer.md
8+
- Using Pattern Builder: using_pattern_builder.md
9+
10+
theme: readthedocs

0 commit comments

Comments
 (0)