search

feulf / raintpl3

The easiest Template Engine for PHP
https://feulf.github.io/raintpl
258 stars 57 forks source link

Documentation on github page #108

Closed feulf closed 8 years ago

feulf commented 11 years ago

It could be nice to start writing a new documentation for RainTPL 3.0 directly here in github, with the github pages, so that everyone can contribute to it.

Anyone of you guys has experience and time to start writing it?

keskad commented 11 years ago

We also need a phpDocumentation generated from PHP code. I saw you started using phpDoc but you made many syntax errors, i can help you fixing them to run web based docs.

feulf commented 11 years ago

a script that write the phpDoc directly in the Github page it could be a nice project, so that every documentation it could just live together with the repository in Github.

I'll check how complex it is to realize

keskad commented 11 years ago

phpDoc is a very complicated machine, so... the best solution is to put phpDoc on external website and link. And on Github only create tutorials reffering to external documentation sometimes.

feulf commented 11 years ago

What I meant is that it could be nice to have an app that parse phpDoc and upload directly as github page of the repo, or a phpDoc plugin that does that.

Anyway we do need Documentations on github page and a phpDocumentation as well.

wintercounter commented 10 years ago

Or you can commit automaticly the generated HTMLs, just a node.js watcher and there you go...

keskad commented 10 years ago

For my project I created a documentation in Markdown format hosted on separate github repository. It can be downloaded and parsed to HTML code to embed on project website :smile: