https://github.com/ph-7/nav-doc-script-v2

:books: Nav Doc V2 is the new version of the little script using simple PHP functions that lets you easily create beautiful multilingual documentation for your software, lets you add some documentation files very easily and highlighting programming code. It has also full Ajax navigation (can be disable by removing the AjPH JS/CSS files)
https://github.com/ph-7/nav-doc-script-v2

developer-tools doc-site doc-website documentation documentation-cms functional highlight-code navdoc ph7-nav-doc php php-functions seo static-site-generator

Last synced: 4 months ago
JSON representation

:books: Nav Doc V2 is the new version of the little script using simple PHP functions that lets you easily create beautiful multilingual documentation for your software, lets you add some documentation files very easily and highlighting programming code. It has also full Ajax navigation (can be disable by removing the AjPH JS/CSS files)

• Host: GitHub
• URL: https://github.com/ph-7/nav-doc-script-v2
• Owner: pH-7
• License: other
• Created: 2012-05-07T10:33:54.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2018-02-03T20:23:10.000Z (almost 7 years ago)
• Last Synced: 2024-05-02T06:14:31.496Z (9 months ago)
• Topics: developer-tools, doc-site, doc-website, documentation, documentation-cms, functional, highlight-code, navdoc, ph7-nav-doc, php, php-functions, seo, static-site-generator
• Language: CSS
• Homepage: http://sourceforge.net/projects/ph7navscript/
• Size: 479 KB
• Stars: 5
• Watchers: 4
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGES
  • License: LICENSE

Awesome Lists containing this project

README

        
# pH7 Nav Doc

## Description

pH7 Nav Doc is a simple and fast script using simple PHP functions that lets you easily **create beautiful multilingual documentation for your software** and lets you add documentation files very easily. 

- It supports multilingual URL and highly optimized for SEO.

- The script allows you to internationalize your documentation thanks its multiple-languages documentation pages and by keeping an excellent SEO for your site. 

- It provides an Ajax interface with jQuery.

- It supports the highlighting programming code in your documentation thanks to [highlight.js](https://highlightjs.org).

## Installation

No installation required. Just transfer the script using your FTP client such as Filezilla.

## How To Create My Doc? 

Simply add your documentation files into a language folder or create a new one with your language (there are already some example files there to help you understanding better how it works).

## Server Requirements

#### Operating System

Linux, BSD, Solaris, Windows or Mac

#### Web Server

Apache, CGI, FastCGI, IIS or ISAPI

#### Application Server

PHP 5.3.0 or higher.

## Who Uses pH7 Nav Doc?

- [pH7CMS Doc](http://ph7cms.com/doc/)

## Author

Pierre-Henry Soria

## Contact

Please contact me with any collaboration with me to develop this script and notify me of any bug reports.

Contact me at: pierrehenrysoria [[ AT ]] gmail [[ D0T ]] com

## License

CC-BY - http://creativecommons.org/licenses/by/3.0/