https://github.com/segundofdez/docstyle
Make simple style guides or documentations using markdown
https://github.com/segundofdez/docstyle
documentation markdown
Last synced: 2 months ago
JSON representation
Make simple style guides or documentations using markdown
- Host: GitHub
- URL: https://github.com/segundofdez/docstyle
- Owner: segundofdez
- License: mit
- Created: 2016-08-11T22:55:49.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2016-08-11T23:34:14.000Z (almost 10 years ago)
- Last Synced: 2025-04-10T00:50:03.335Z (about 1 year ago)
- Topics: documentation, markdown
- Language: CSS
- Size: 229 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
#docstyle
Welcome to docstyle basic template. The purpose of this project is to offer a simple layout to make style guides or simple documentations using markdown files.
## Install
1. Download de latest version of docstyle
2. composer install
3. bower install
4. npm install
## Configure
You can configure some parameters like sitename, lang, description... in **public/index.php**. Also you can configure your .md files routes.
```php
$data = [
'home' => $home,
'lang' => 'en',
'title' => 'docstyle',
'description' => 'Basic template for styleguides or documentations using markdown',
'version' => '1.0.0',
'getting_started' => $parse->text( file_get_contents( $data_dir . '00_getting_started.md') ),
];
```
Add the routes in your template **source/templates**
```html
[...]
[...]
[...]
```
## Start
Add your markdow files to **source/data**.
If you need a diferent skin, you can modify the styles in **source/styles**.
## Gulp
Start a php server, browser-sync, watch changes on .less, .php, .md and .js:
```bash
gulp connect
```
Compile, minified and autoprefix styles to css:
```bash
gulp less
```
Minimize js:
```bash
gulp js
```
Generate static html from php files:
```bash
gulp static
```
## Contributing
Please see [CONTRIBUTING](https://github.com/segundofdez/docstyle/blob/master/CONTRIBUTING.md) for details.
## Creators
**Segundo Fdez**
-
-
**Contributors**
-
## License
Copyright (c) 2016 Segundo Fdez (http://segundofdez.com) Code released under the [the MIT license](https://github.com/segundofdez/docstyle/blob/master/LICENSE.md)