Daux.io is an 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.

Overview

Daux.io - Deprecation Notice

This repository is deprecated!

Daux.io has been moved to an organization, to guarantee future development and support. So please refer to the new project repository. New issues or pull requests on the old repository will be ignored!

dauxio/daux.io

Comments
  • Relative image links

    Relative image links

    Hi, thanks for you work on this nice tool. I sometimes need to embed images in my documentation, so I use ![](https://avatars1.githubusercontent.com/u/3950390?s=140) in my markdown file and it renders like

    In Github READMEs it is also possible to use a relative URL for images (eg ![](images/schema.png) or ![](screenshot.png), whereas daux.io displays nothing when I use a relative path.

    How is it possible to display images living in the same directory as the docs?

    opened by nodiscc 23
  • Patch / Sort update

    Patch / Sort update

    Patch to temporarily correct unassigned "entry_page" value when a sub-folder only contains a single index.

    Preliminary sort on build tree to improve first_page identification.

    Need testing on "View Documentation" assignment when only nested index pages are available. Currently fails with invalid URI.

    opened by holodyn 18
  • How to start editor

    How to start editor

    For the life of me I can't figure out how to enable the markdown editor.

    I tried adding { "file_editor": true, } to config.json but nothing happens once I compile the static page.

    opened by daddyfix 18
  • Falls apart on wide viewport

    Falls apart on wide viewport

    The Code Highlighting page falls apart on Firefox 22 ("Mozilla/5.0 (Windows NT 6.1; WOW64; rv:22.0) Gecko/20100101 Firefox/22.0"). It's good on 1145, and broken on 1150 (as given by document.documentElement.clientWidth).

    Support 
    opened by PAStheLoD 16
  • Move to an organization

    Move to an organization

    Hi @justinwalsh,

    I tried to contact you about this but got no answer from you.

    Can we move daux.io to an organization ? I created one and invited you to it : https://github.com/dauxio

    Also, the development/production sites don't update anymore on push. Is it possible for me to take the domain and move the site to my servers ?

    Thanks in advance

    opened by onigoetz 15
  • Adding a simple login system

    Adding a simple login system

    Is their a way to add an optional simple login system to this documentation web app? I would love to use this for my company web app documentation, however, it has some sensitive information that I need to keep secure. Thanks for your suggestions.

    Enhancement 
    opened by nathanjisaac 15
  • Big reorganisation

    Big reorganisation

    Hi,

    I know this is a big pull request, but I needed all these functionnalities at the same time and could not make a lot of small pull requests. I will explain what I did in details here.

    General

    • PSR-2 Coding style is now PSR-2, this eases the collaboration between projects
    • PHP 5.4 is a minimum, it makes the code more readable in some places. and PHP 5.3 is unsupported for a long time now

    Code Structure

    • Uses PSR-4 Standard, easier autoloading.
    • Separated "Generator" and "Server" make a much clearer code.
    • Also separated "Tree" to generate the structure.

    Features

    • Abstract generation system, be able to choose how to generate the documentation
    • Added Atlassian Confluence upload support (with image attachments and code highlight)
    • Replaced Parsedown by CommonMark
    • Added internal links
    • Extend Daux with "Processors" a class to change the tree and generate new pages on the fly
    • The project is packaged as phar archive. allowing to run easily without requiring dozens of files. easy to commit with the documented project.

    Documentation structure

    • Images are now directly in the docs folder, make a more contained documentation : generator/server on one side, documentation on the other
    • resources folder contains js files, themes and img. makes it easier to configure the copy on generation.

    Templates

    • Templates are now generated with http://platesphp.com/
    • Templates are much cleaner and overridable by creating a templates folder inside the theme and naming the template the same way as the original one. the engine does the rest.

    Bugfixes

    • in generated mode, the name of the documentation links to index instead of index.html
    • if there are no links, the documentation doesn't show the "show/hide code blocks" toggle
    • a _index.md page in a sub folder now uses the default template and not the one for homepages.
    • Page.md is exactly the same as Page/_index.md, the index Page calculation takes it in account.

    Don't hesitate if you want me to fix/change something before you accept the pull request.

    opened by onigoetz 14
  • Backslash in URLs breaks website in Firefox and IE

    Backslash in URLs breaks website in Firefox and IE

    I downloaded daux.io-master and ran "npm install" followed by "grunt" without changing any of the default settings or content. The site shows up correctly in Chrome but expand/collapse links such as "Examples" and "More Examples" don't work in IE and there is no style at all in Firefox.

    Viewing the source, I see links like this:

    <link href='//127.0.0.1:8085/templates/default/themes/daux-blue/css/daux-blue.css' rel='stylesheet' type='text/css'>

    I don't know why there's a backslash after the port number, but that almost certainly is the cause of the problem. (All three browsers show this in the source, but they have mixed results in handling it.)

    My environment: Windows 7 (64-bit) SP1 node.js 0.12.2 php 5.6.0 Firefox 37.0.1

    Bug Windows 
    opened by kenlyon 14
  • Create a grunt task to build a static set of the docs.

    Create a grunt task to build a static set of the docs.

    This would be useful if you wanted to deploy to S3, Github Pages, or any static file server.

    From reddit user:

    This project looked very appealing to me, until I read this part. I am not interested in a service like DocumentUp, I just want to be able to put the generated documentation on our CDN or S3, on our domain. We also have the need for internal docs that we don't want on any public server. I think the solution to this is to add support for optional, purely static export. An external, hosted documentation service will not fit our needs.

    Enhancement 
    opened by justinwalsh 14
  • Daux.io Website is Down

    Daux.io Website is Down

    Here is the error that I have when trying to access the website:

    This site can’t be reached daux.io’s server DNS address could not be found. Search Google for daux io ERR_NAME_NOT_RESOLVED

    Bug 
    opened by VincEmond 13
  • Float = false does not seem to make a difference

    Float = false does not seem to make a difference

    Hi,

    This looks like a very nice documentation generator, but I am trying to remove the right code column, and have the code stay in the main content area.

    I am trying this with the provided example docs folder, and I have edited its float attribute to be false. I expected the result to be like this and instead, I still have the right code column. I am viewing this on a wide desktop screen, Chrome on Windows. I can provide a screenshot if needed, but it looks like the screenshot in issue #25

    Bug Theme 
    opened by DannyBen 13
Releases(0.4.0)
  • 0.4.0(Jun 7, 2017)

    New Style

    A new style giving more space to the actual documentation is the biggest feature in this release.

    New features

    • New buttons option allows to add new buttons on the landing page, thanks @aidan-casey for the contribution (#444)
    • Jump buttons at the bottom of the page can now be disabled with a new jump_buttons option, thanks @eisbehr- for the contribution (#455, #459)

    Documentation improvements

    • Clarify documentation, improve discoverability of features and options (#453)
    • Clarify which MarkDown flavor we use (#460)
    • Added another site as usage example (#450)
    • Fixed headings, thanks @bennyn for the contribution (#446)
    • Fix readme links (#457)

    Bugfixes

    • Computed raw pages now send the correct mime type as a header
    • Fixed missing homeage title when auto_landing is disabled (#456)
    • Fix TOC links taht have the same name and with non-ascii characters (#461)
    • Fixed image embedding for confluence (#439)
    • Reduced memory usage by lazy-loading all content and removing it from memory when finished (#443)

    Miscellaneous

    • Updated dependencies
    • Removed HHVM from test matrix
    • Removed PHP 5.5 support, minimum version is now 5.6
    Source code(tar.gz)
    Source code(zip)
  • 0.3.2(Jun 6, 2017)

    • Fix mailto links in file resolution #433 #435, thanks @wiggisser for the fix
    • Tweak search on mobile #432
    • Update documentation about windows support #180
    Source code(tar.gz)
    Source code(zip)
  • 0.3.1(Jun 6, 2017)

  • 0.3.0(Nov 18, 2016)

    New Features

    • the Confluence upload now does a configuration check to break early.
    • the "Edit on GitHub" feature is now expanded to support any other tool.
    • Allow to specify a custom themes directory, other than "themes"
    • Allow custom configuration and custom Processors in daux CLI

    Updates

    • Updated to CommonMark 0.15, fixes a problem with list indentation
    • Update highlight.js to 9.7.0, add all possible languages

    Fixes

    • Handle links with an anchor
    • Fix TOC generation
    Source code(tar.gz)
    Source code(zip)
  • 0.2.3(Nov 18, 2016)

  • 0.2.2(Nov 18, 2016)

    • Broken links appear in red in the documentation instead of breaking in daux serve

    GitHub

    • Remove "fork on github" ribbon, add a link in footer instead
    • Add an "Edit on GitHub" link on all pages
    Source code(tar.gz)
    Source code(zip)
  • 0.2.1(Nov 18, 2016)

  • 0.2.0(Nov 18, 2016)

    Major changes

    • Added a daux cli command to run daux, either with daux generate or daux serve
    • Started to run unit tests in Travis-ci
    • Add automatic table of contents feature
    • Replace Twitter Bootstrap with home made styles, following the BEM convention
    • Removed PHP 5.4 support

    Bugfixes

    • Front-matter wasn't working in some cases, use a real yaml parser
    Source code(tar.gz)
    Source code(zip)
  • 0.1.0(Nov 18, 2016)

Owner
Justin Walsh
Justin Walsh
Simple forum software for building great communities.

About Flarum Flarum is a delightfully simple discussion platform for your website. It's fast and easy to use, with all the features you need to run a

Flarum 5.7k Sep 21, 2022
Documentation generator for PHP Code using standard technology (SRC, DOCBLOCK, XML and XSLT)

phpDox phpDox is a documentation generator for PHP projects. This includes, but is not limited to, API documentation. The main focus is on enriching t

Arne Blankerts 586 Jul 24, 2022
Documentation Generator for PHP

phpDocumentor What is phpDocumentor? phpDocumentor is an application that is capable of analyzing your PHP source code and DocBlock comments to genera

phpDocumentor 3.7k Sep 28, 2022
An API documentation generator

Sami: an API documentation generator WARNING: Sami is not supported nor maintained anymore. Feel free to fork. Curious about what Sami generates? Have

null 2k Sep 19, 2022
A php API documentation generator, fork of Sami

Doctum, a PHP API documentation generator. Fork of Sami Curious about what Doctum generates? Have a look at the MariaDB MySQL Kbs or Laravel documenta

Code LTS 184 Sep 14, 2022
Documentation Generator for WordPress.

Pronamic WordPress Documentor is a tool to automatically extract data about the actions and filters of your WordPress theme or plugin.

Pronamic 34 Aug 27, 2022
Sami: an API documentation generator

Sami: an API documentation generator WARNING: Sami is not supported nor maintained anymore. Feel free to fork. Curious about what Sami generates? Have

null 2k Sep 23, 2022
FluxBB is a fast, light, user-friendly forum application for your website.

FluxBB 1.5 Readme About FluxBB is an open source forum application released under the GNU General Public Licence. It is free to download and use and w

FluxBB 474 Sep 9, 2022
PHP Developer Roadmap

This is PHP Developer Roadmap

TheCodeholic 2k Sep 23, 2022
Learn how to implement the most important Design Patterns into your PHP application, uses PHP 8.1

Learn how to implement the most important Design Patterns into your PHP application. This project uses PHP 8.1. it has examples for each Pattern and an Article explaining how to use them step by step, their advantages, and disadvantages.

Gabriel Anhaia 186 Sep 11, 2022
PHP 7.1 ready Smart and Simple Documentation for your PHP project

Smart and Readable Documentation for your PHP project ApiGen is the simplest, the easiest to use and the most modern api doc generator. It is all PHP

ApiGen 2.1k Sep 22, 2022
PHP 7.1 ready Smart and Simple Documentation for your PHP project

Smart and Readable Documentation for your PHP project ApiGen is the simplest, the easiest to use and the most modern api doc generator. It is all PHP

ApiGen 2.1k Apr 20, 2021
phpDocumentor is an application that is capable of analyzing your PHP source code and DocBlock comments to generate a complete set of API Documentation

phpDocumentor What is phpDocumentor? phpDocumentor is an application that is capable of analyzing your PHP source code and DocBlock comments to genera

phpDocumentor 3.7k Sep 27, 2022
Generates documentation for your REST API from annotations

NelmioApiDocBundle The NelmioApiDocBundle bundle allows you to generate a decent documentation for your APIs. Migrate from 3.x to 4.0 To migrate from

Nelmio 2.1k Sep 21, 2022
Generate interactive OpenAPI documentation for your RESTful API using doctrine annotations

Generate interactive OpenAPI documentation for your RESTful API using doctrine annotations

Robert Allen 4.6k Sep 23, 2022
Generate Sphinx/ReStructured documentation from PHPDoc

PHP-phpdoc-to-rst Forked from Francesco "Abbadon1334" Danti by AeonDigital. In this fork the changes has only visual and superficial effects [ just be

Rianna Cantarelli 0 Nov 16, 2021
Simple and effective multi-format Web API Server to host your PHP API as Pragmatic REST and / or RESTful API

Luracast Restler ![Gitter](https://badges.gitter.im/Join Chat.svg) Version 3.0 Release Candidate 5 Restler is a simple and effective multi-format Web

Luracast 1.3k Sep 27, 2022
allourideas allows groups to collect and priorize information in an open, democratic, and efficient process.

All Our Ideas All Our Ideas 2.0. This codebase runs two sites photocracy.org and allourideas.org. The allourideas.org project provides the user-facing

All Our Ideas 153 Sep 13, 2022
PhpMetrics provides metrics about PHP project and classes, with beautiful and readable HTML report.

PhpMetrics provides metrics about PHP project and classes, with beautiful and readable HTML report.

PhpMetrics 2.3k Sep 26, 2022