D3Public/daux.io
8
0
Fork 0
Code Pull Requests Releases Activity

Rename package and repository

Browse Source
This commit is contained in:
Stéphane Goetz 2017-09-13 21:43:40 +02:00
parent 77d5e9fe5e
commit 70ecd5c2e2
11 changed files with 44 additions and 42 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -1,12 +1,12 @@
# Daux.io # Daux.io
[![Latest Version](https://img.shields.io/github/release/justinwalsh/daux.io.svg?style=flat-square)](https://github.com/justinwalsh/daux.io/releases) [![Latest Version](https://img.shields.io/github/release/dauxio/daux.io.svg?style=flat-square)](https://github.com/dauxio/daux.io/releases)
[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](https://github.com/justinwalsh/daux.io/blob/master/LICENSE.md) [![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](https://github.com/dauxio/daux.io/blob/master/LICENSE.md)
[![Build Status](https://img.shields.io/travis/onigoetz/daux.io/master.svg?style=flat-square)](https://travis-ci.org/onigoetz/daux.io) [![Build Status](https://img.shields.io/travis/dauxio/daux.io/master.svg?style=flat-square)](https://travis-ci.org/dauxio/daux.io)
[![Coverage Status](https://img.shields.io/scrutinizer/coverage/g/onigoetz/daux.io.svg?style=flat-square)](https://scrutinizer-ci.com/g/onigoetz/daux.io/code-structure) [![Coverage Status](https://img.shields.io/scrutinizer/coverage/g/dauxio/daux.io.svg?style=flat-square)](https://scrutinizer-ci.com/g/dauxio/daux.io/code-structure)
[![Quality Score](https://img.shields.io/scrutinizer/g/onigoetz/daux.io.svg?style=flat-square)](https://scrutinizer-ci.com/g/onigoetz/daux.io) [![Quality Score](https://img.shields.io/scrutinizer/g/dauxio/daux.io.svg?style=flat-square)](https://scrutinizer-ci.com/g/dauxio/daux.io)
[![Total Downloads](https://img.shields.io/packagist/dt/justinwalsh/daux.io.svg?style=flat-square)](https://packagist.org/packages/justinwalsh/daux.io) [![Total Downloads](https://img.shields.io/packagist/dt/dauxio/daux.io.svg?style=flat-square)](https://packagist.org/packages/dauxio/daux.io)
**Daux.io** is a documentation generator that uses a simple folder structure and Markdown files to create custom documentation on the fly. It helps you create great looking documentation in a developer friendly way. **Daux.io** is a documentation generator that uses a simple folder structure and Markdown files to create custom documentation on the fly. It helps you create great looking documentation in a developer friendly way.
@ -45,12 +45,12 @@ This is a list of sites using Daux.io:
* [Cumulus TV: Android TV app that turns any stream/page into a Live Channel](http://cumulustv.herokuapp.com) * [Cumulus TV: Android TV app that turns any stream/page into a Live Channel](http://cumulustv.herokuapp.com)
* [Nuntius: A PHP framework for bots](https://roysegall.github.io/nuntius-bot/) * [Nuntius: A PHP framework for bots](https://roysegall.github.io/nuntius-bot/)
Do you use Daux.io? Send me a pull request or open an [issue](https://github.com/justinwalsh/daux.io/issues) and I will add you to the list. Do you use Daux.io? Send me a pull request or open an [issue](https://github.com/dauxio/daux.io/issues) and I will add you to the list.
## Install ## Install
``` ```
composer global require justinwalsh/daux.io composer global require dauxio/daux.io
``` ```
You can then use the `daux` command line to generate your documentation. You can then use the `daux` command line to generate your documentation.
@ -234,4 +234,4 @@ If you encounter an error similar to `utf8_decode() not found` this means that y
## Support ## Support
If you need help using Daux.io, or have found a bug, please create an issue on the <a href="https://github.com/justinwalsh/daux.io/issues" target="_blank">GitHub repo</a>. If you need help using Daux.io, or have found a bug, please create an issue on the <a href="https://github.com/dauxio/daux.io/issues" target="_blank">GitHub repo</a>.

4
bin/daux
View File

@ -27,14 +27,14 @@ Feedback & Suggestions
To give us feedback or to suggest an idea, please create an request on the the To give us feedback or to suggest an idea, please create an request on the the
GitHub issue tracker: GitHub issue tracker:
https://github.com/justinwalsh/daux.io/issues https://github.com/dauxio/daux.io/issues
Bugs Bugs
---- ----
To file bug reports please create an issue using the github issue tracker: To file bug reports please create an issue using the github issue tracker:
https://github.com/justinwalsh/daux.io/issues https://github.com/dauxio/daux.io/issues
Copyright and License Copyright and License

7
composer.json
View File

@ -1,10 +1,10 @@
{ {
"name": "justinwalsh/daux.io", "name": "daux/daux.io",
"type": "project", "type": "project",
"license": "MIT", "license": "MIT",
"description": "Documentation generator that uses a simple folder structure and Markdown files to create custom documentation on the fly", "description": "Documentation generator that uses a simple folder structure and Markdown files to create custom documentation on the fly",
"keywords": ["documentation", "docs", "markdown", "md"], "keywords": ["documentation", "docs", "markdown", "md"],
"homepage": "http://daux.io/", "homepage": "https://dauxio.github.io/",
"authors": [ "authors": [
{ {
"name": "Justin Walsh", "name": "Justin Walsh",
@ -30,6 +30,9 @@
"Todaymade\\Daux\\": "libs/" "Todaymade\\Daux\\": "libs/"
} }
}, },
"replace": {
"justinwalsh/daux.io": "*"
},
"require-dev": { "require-dev": {
"phpunit/phpunit": "~5", "phpunit/phpunit": "~5",
"mikey179/vfsStream": "^1.6" "mikey179/vfsStream": "^1.6"

6
docs/00_Getting_Started.md
View File

@ -43,14 +43,14 @@ This is a list of sites using Daux.io:
* [Munee: Standalone PHP 5.3 Asset Optimisation & Manipulation](http://mun.ee) * [Munee: Standalone PHP 5.3 Asset Optimisation & Manipulation](http://mun.ee)
* [ICADMIN: An admin panel powered by CodeIgniter.](http://istocode.com/shared/ic-admin/) * [ICADMIN: An admin panel powered by CodeIgniter.](http://istocode.com/shared/ic-admin/)
Do you use Daux.io? Send us a pull request or open an [issue](https://github.com/justinwalsh/daux.io/issues) and I will add you to the list. Do you use Daux.io? Send us a pull request or open an [issue](https://github.com/dauxio/daux.io/issues) and I will add you to the list.
## Getting Started ## Getting Started
### Install ### Install
``` ```
composer global require justinwalsh/daux.io composer global require dauxio/daux.io
``` ```
You can then use the `daux` command line to generate your documentation. You can then use the `daux` command line to generate your documentation.
@ -137,4 +137,4 @@ If you encounter an error similar to `utf8_decode() not found` this means that y
## Support ## Support
If you need help using Daux.io, or have found a bug, please create an issue on the <a href="https://github.com/justinwalsh/daux.io/issues" target="_blank">GitHub repo</a>. If you need help using Daux.io, or have found a bug, please create an issue on the <a href="https://github.com/dauxio/daux.io/issues" target="_blank">GitHub repo</a>.

2
docs/01_Features/CommonMark_compliant.md
View File

@ -119,4 +119,4 @@ Here's an image.
Note: to use images on a landing page (index.md), prefix the image URL with the name of the directory it appears in, omitting the numerical prefix used to order the sections. For example in this section, to display this image on the landing page (index.md), the URL for the image would be "Features/sampleimage.png" to display the same image. Note: to use images on a landing page (index.md), prefix the image URL with the name of the directory it appears in, omitting the numerical prefix used to order the sections. For example in this section, to display this image on the landing page (index.md), the URL for the image would be "Features/sampleimage.png" to display the same image.
*View the [source of this content](https://github.com/justinwalsh/daux.io/blob/master/docs/01_Features/CommonMark_compliant.md).* *View the [source of this content](https://github.com/dauxio/daux.io/blob/master/docs/01_Features/CommonMark_compliant.md).*

4
docs/01_Features/Edit_on_GitHub_links.md
View File

@ -11,7 +11,7 @@ Daux.io will handle the rest
```json ```json
{ {
"html": { "html": {
"edit_on_github": "justinwalsh/daux.io/blob/master/docs" "edit_on_github": "dauxio/daux.io/blob/master/docs"
} }
} }
``` ```
@ -28,7 +28,7 @@ As long as you can refer your files by a URL, you can create an edit link for yo
"html": { "html": {
"edit_on": { "edit_on": {
"name": "Bitbucket", "name": "Bitbucket",
"basepath": "https://bitbucket.org/onigoetz/daux.io/src/master/docs" "basepath": "https://bitbucket.org/dauxio/daux.io/src/master/docs"
} }
} }
} }

6
docs/05_Configuration/Html_export.md
View File

@ -85,7 +85,7 @@ Add a 'Fork me on GitHub' ribbon.
```json ```json
{ {
"html": { "repo": "justinwalsh/daux.io" } "html": { "repo": "dauxio/daux.io" }
} }
``` ```
@ -118,8 +118,8 @@ Include custom links in the sidebar.
{ {
"html": { "html": {
"links": { "links": {
"GitHub Repo": "https://github.com/justinwalsh/daux.io", "GitHub Repo": "https://github.com/dauxio/daux.io",
"Help/Support/Bugs": "https://github.com/justinwalsh/daux.io/issues", "Help/Support/Bugs": "https://github.com/dauxio/daux.io/issues",
"Made by Todaymade": "http://todaymade.com" "Made by Todaymade": "http://todaymade.com"
} }
} }

13
docs/config.json
View File

@ -19,15 +19,14 @@
"float": true, "float": true,
"inherit_index": true, "inherit_index": true,
"repo": "justinwalsh/daux.io", "repo": "dauxio/daux.io",
"edit_on_github": "justinwalsh/daux.io/blob/master/docs", "edit_on_github": "dauxio/daux.io/blob/master/docs",
"twitter": ["justin_walsh", "todaymade"], "twitter": ["onigoetz"],
"google_analytics": "UA-12653604-10", "google_analytics": "UA-12653604-10",
"links": { "links": {
"Download": "https://github.com/justinwalsh/daux.io/archive/master.zip", "Download": "https://github.com/dauxio/daux.io/archive/master.zip",
"GitHub Repo": "https://github.com/justinwalsh/daux.io", "GitHub Repo": "https://github.com/dauxio/daux.io",
"Help/Support/Bugs": "https://github.com/justinwalsh/daux.io/issues", "Help/Support/Bugs": "https://github.com/dauxio/daux.io/issues"
"Made by Todaymade": "http://todaymade.com"
} }
} }
} }

4
generate
View File

@ -27,14 +27,14 @@ Feedback & Suggestions
To give us feedback or to suggest an idea, please create an request on the the To give us feedback or to suggest an idea, please create an request on the the
GitHub issue tracker: GitHub issue tracker:
https://github.com/justinwalsh/daux.io/issues https://github.com/dauxio/daux.io/issues
Bugs Bugs
---- ----
To file bug reports please create an issue using the github issue tracker: To file bug reports please create an issue using the github issue tracker:
https://github.com/justinwalsh/daux.io/issues https://github.com/dauxio/daux.io/issues
Copyright and License Copyright and License

4
index.php
View File

@ -26,14 +26,14 @@ Feedback & Suggestions
To give us feedback or to suggest an idea, please create an request on the the To give us feedback or to suggest an idea, please create an request on the the
GitHub issue tracker: GitHub issue tracker:
https://github.com/justinwalsh/daux.io/issues https://github.com/dauxio/daux.io/issues
Bugs Bugs
---- ----
To file bug reports please create an issue using the github issue tracker: To file bug reports please create an issue using the github issue tracker:
https://github.com/justinwalsh/daux.io/issues https://github.com/dauxio/daux.io/issues
Copyright and License Copyright and License

18
tests/Format/HTML/ConfigTest.php
View File

@ -13,25 +13,25 @@ class ConfigTest extends \PHPUnit_Framework_TestCase
public function providerEditOn() public function providerEditOn()
{ {
$github_result = ['name' => 'GitHub', 'basepath' => 'https://github.com/justinwalsh/daux.io/blob/master/docs']; $github_result = ['name' => 'GitHub', 'basepath' => 'https://github.com/dauxio/daux.io/blob/master/docs'];
return [ return [
[[], null], [[], null],
[['edit_on_github' => 'justinwalsh/daux.io/blob/master/docs'], $github_result], [['edit_on_github' => 'dauxio/daux.io/blob/master/docs'], $github_result],
// Allow formatting in many ways // Allow formatting in many ways
[['edit_on_github' => 'justinwalsh/daux.io/blob/master/docs/'], $github_result], [['edit_on_github' => 'dauxio/daux.io/blob/master/docs/'], $github_result],
[['edit_on_github' => '/justinwalsh/daux.io/blob/master/docs'], $github_result], [['edit_on_github' => '/dauxio/daux.io/blob/master/docs'], $github_result],
[['edit_on_github' => 'https://github.com/justinwalsh/daux.io/blob/master/docs/'], $github_result], [['edit_on_github' => 'https://github.com/dauxio/daux.io/blob/master/docs/'], $github_result],
[['edit_on_github' => 'http://github.com/justinwalsh/daux.io/blob/master/docs/'], $github_result], [['edit_on_github' => 'http://github.com/dauxio/daux.io/blob/master/docs/'], $github_result],
// Fallback if a string is provided to 'edit_on' // Fallback if a string is provided to 'edit_on'
[['edit_on' => 'justinwalsh/daux.io/blob/master/docs'], $github_result], [['edit_on' => 'dauxio/daux.io/blob/master/docs'], $github_result],
// Support any provider // Support any provider
[ [
['edit_on' => ['name' => 'Bitbucket', 'basepath' => 'https://bitbucket.org/onigoetz/daux.io/src/master/docs/']], ['edit_on' => ['name' => 'Bitbucket', 'basepath' => 'https://bitbucket.org/dauxio/daux.io/src/master/docs/']],
['name' => 'Bitbucket', 'basepath' => 'https://bitbucket.org/onigoetz/daux.io/src/master/docs'] ['name' => 'Bitbucket', 'basepath' => 'https://bitbucket.org/dauxio/daux.io/src/master/docs']
] ]
]; ];
} }