Update rdoc

This commit is contained in:
Rico Sta. Cruz 2017-08-27 23:27:41 +08:00
parent e366c7d71d
commit c99467b22f
No known key found for this signature in database
GPG Key ID: CAAD38AE2962619A
2 changed files with 59 additions and 30 deletions

View File

@ -4,27 +4,32 @@
## Notes ## Notes
H2's support these: `h2` supports these:
{: .-two-column} {: .-two-column}
{: .-three-column} {: .-three-column}
{: .-left-reference} {: .-left-reference}
H3's support these: `h3` supports these:
{: .-prime} {: .-prime}
Tables support these: `table` supports these:
{: .-shortcuts} {: .-shortcuts}
Pre's support these: `pre` supports these:
{: .-setup} {: .-setup}
`ul` supports these:
{: .-also-see}
Each sheet supports these metadata: Each sheet supports these metadata:
```yml ```yml
---
title: React.js title: React.js
category: React category: React
layout: 2017/sheet # 'default' | '2017/sheet' layout: 2017/sheet # 'default' | '2017/sheet'

76
rdoc.md
View File

@ -1,6 +1,7 @@
--- ---
title: Rdoc title: Rdoc
category: Markup category: Markup
layout: 2017/sheet
--- ---
### Basic RDoc format ### Basic RDoc format
@ -17,31 +18,45 @@ category: Markup
# @see http://url.com # @see http://url.com
# #
# @return [true] if so # @return [true] if so
#
# == Definition lists
#
# list:: hi.
# +foo+:: parameterized
#
# == Definition lists
# [foo] also
# [bar] like this
### Inline ### Inline
*bold* ```
_emphasized_ *bold*
+code+ _emphasized_
+code+
```
http://www.link.com ```
See Models::User@Examples http://www.link.com
{Google}[http://google.com] See Models::User@Examples
{Google}[http://google.com]
```
### Skip ### Skip
def input # :nodoc: ```rb
def input # :nodoc:
```
module MyModule # :nodoc: all ```rb
module MyModule # :nodoc: all
```
### Definition lists
```
# == Definition lists
#
# list:: hi.
# +foo+:: parameterized
```
```
# == Definition lists
# [foo] also
# [bar] like this
```
### Return types ### Return types
@ -65,17 +80,26 @@ category: Markup
### Sections ### Sections
# :section: Expiry methods ```rb
# methods relating to expiring # :section: Expiry methods
# methods relating to expiring
def expire! def expire!
def expired? def expired?
... ...
```
### Using tomdoc ### Using tomdoc
# :markup: TomDoc ```
# at the beginning ofthe file # :markup: TomDoc
```
http://rdoc.rubyforge.org/RDoc/Markup.html Plase this at the beginning of the file.
http://www.rubydoc.info/gems/yard/file/docs/GettingStarted.md
## Also see
{: .-one-column}
* <http://rdoc.rubyforge.org/RDoc/Markup.html>
* <http://www.rubydoc.info/gems/yard/file/docs/GettingStarted.md>
{: .-also-see}