tonyair/silverstripe-framework
1
0
Fork 0
mirror of https://github.com/silverstripe/silverstripe-framework synced 2024-10-22 14:05:37 +02:00
Code Issues Projects Releases Wiki Activity

Fixed sapphiredocs references

Browse Source
This commit is contained in:
Ingo Schommer 2012-11-06 11:01:48 +01:00
parent c1ae13ffb0
commit bcee252c2f
3 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/en/misc/contributing/documentation.md
View File

@ -39,7 +39,7 @@ getting out of date.
* End-user: [userhelp.silverstripe.org](http://userhelp.silverstripe.org) - a custom SilverStripe project (not open sourced at the moment).
* Developer Guides: [doc.silverstripe.org](http://doc.silverstripe.org) - powered by a
SilverStripe project that uses the ["sapphiredocs" module](https://github.com/silverstripe/silverstripe-sapphiredocs)
SilverStripe project that uses the ["docsviewer" module](https://github.com/silverstripe/silverstripe-docsviewer)
to convert Markdown formatted files into searchable HTML pages with index lists.
Its contents are fetched from different releases automatically every couple of minutes.
* Developer API Docuumentation: [api.silverstripe.org](http://api.silverstripe.org) - powered by a customized

2
docs/en/misc/module-release-process.md
View File

@ -111,7 +111,7 @@ that you can link from the `README.md` file. Example:
tutorial.md
howto-search-mymodule.md
The ["sapphiredocs" module](http://open.silverstripe.org/browser/modules/sapphiredocs/trunk) can be used
The ["docsviewer" module](http://open.silverstripe.org/browser/modules/docsviewer/trunk) can be used
to list and render content inside a `docs/` folder (although it is not required, Markdown is designed
to be readable in plain text as well).

12
docs/en/misc/ss-markdown.md
View File

@ -17,9 +17,9 @@ and HTML output should still be readable with our custom markup unparsed.
While most of the Markdown syntax is parseable by all common implementations,
the special syntax is relying on a custom SilverStripe project that powers `http://doc.silverstripe.org`.
The website a standard SilverStripe installation with the [sapphiredocs](https://github.com/silverstripe/silverstripe-sapphiredocs/)
module installed (see module [README](https://github.com/silverstripe/silverstripe-sapphiredocs/blob/master/README.md) and
[documentation](https://github.com/silverstripe/silverstripe-sapphiredocs/tree/master/docs/en)).
The website a standard SilverStripe installation with the [docsviewer](https://github.com/silverstripe/silverstripe-docsviewer/)
module installed (see module [README](https://github.com/silverstripe/silverstripe-docsviewer/blob/master/README.md) and
[documentation](https://github.com/silverstripe/silverstripe-docsviewer/tree/master/docs/en)).
## Syntax
@ -96,11 +96,11 @@ You can link to absolute image URLs as well, of course.
### How do I preview my own SS Markdown?
Thats only possible with the `sapphiredocs` module - we don't have a standalone parser.
Thats only possible with the `docsviewer` module - we don't have a standalone parser.
### Can I run my own documentation server?
Yes, the `sapphiredocs` module just requires a default SilverStripe installation (2.4+).
Yes, the `docsviewer` module just requires a default SilverStripe installation (2.4+).
### Can I generate SS Markdown other formats?
@ -108,7 +108,7 @@ Currently this is not supported, as all HTML is generated on the fly.
### Can I contribute to the parser and rendering project?
Of course, the `sapphiredocs` code is BSD licensed - we're looking forward to your contributions!
Of course, the `docsviewer` code is BSD licensed - we're looking forward to your contributions!
## Related ##