Skip to content

Instantly share code, notes, and snippets.

@gfarfanb
Last active June 3, 2018 08:00
Show Gist options
  • Save gfarfanb/64ac4a848e1b483bf63443cf9a2c8f59 to your computer and use it in GitHub Desktop.
Save gfarfanb/64ac4a848e1b483bf63443cf9a2c8f59 to your computer and use it in GitHub Desktop.
Fuga Specification: Knowledge Map Model Specification.

Fuga Specification (GitHub-flavoured Markdown)

This is intended as a quick reference and showcase for Fuga Specification (Knowledge Map Model Specification).

For more detail about Markdown specification, see Markdown original spec and Writing on GitHub.

You can edit your Markdown code on this Markdown Editor.

:emoji: is not considered

Table of Content

Properties
Headers
Authors
References
Resources
Content
Notes & Annotations
Comments

Properties

Property reference

  • Visible properties is represented by +
  • Hidden properties is represented by -
Syntax
Content[+](https://url.reference/or/#reference)

Block [{+}](https://url.reference/or/#reference)

Column [\|+\|](https://url.reference/or/#reference)

Row [\_+\_](https://url.reference/or/#reference)
Example

Content with visible properties+

Header 1 |+| Header 2
Cell 1 Cell 2 _+_
{+}

Property details

Hidden properties

  • Any markdown is supported
  • Do not empty new lines
  • Escape parenthesis \(\)
  • You can use internal comment // Comment
Syntax
[//]: # (
   property-name.<property>: <value>
   property-name.<property>:
      <value>
)
Example
[//]: # (
   hidden-property.name: value
   hidden-property.reference: [reference]\(#\)
   hidden-property.content: 
      content, **bold**, *italic*, ~~obsolete~~
      > annotation
      first | second
      ----- | ------
      one | two 
   hidden-property.complex: value[+]\(#property\)
)

Hidden properties are not visible because [//]: # (...) syntax

Visible properties

  • (optional) Use --- as properties area delimiter
  • (optional) Use ###### header to match with property reference [+](#header)
Syntax
property-name.<property>: <value>
property-name.<property>:
   <value>
Example
---
###### visible-property
- visible-properties.name: value
- visible-properties.reference: [reference](#)
- visible-properties.content: 
   content, **bold**, *italic*, ~~obsolete~~
   > annotation
   
   first | second
   ----- | ------
   one | two 
- visible-property.complex: value[+](#property)

visible-property
  • visible-properties.name: value

  • visible-properties.reference: reference

  • visible-properties.content: content, bold, italic, obsolete

    annotation

    first second
    one two
  • visible-property.complex: value+


Headers

Syntax
# H1
## H2
### H3
#### H4
##### H5
###### H6

# H1 [+](#property)
## H2 [+](#property)
### H3 [+](#property)
#### H4 [+](#property)
##### H5 [+](#property)
###### H6 [+](#property)
Example

Header level 1

Header level 2

Header level 3

Header level 4

Header level 5
Header level 6

Header level 1 +

Header level 2 +

Header level 3 +

Header level 4 +

Header level 5 +
Header level 6 +

Authors

Syntax
@author

@author[+](#property)
Example

@author

@author+

References

Syntax
[reference](https://url.reference/or/#reference)

[reference](https://url.reference/or/#reference)[+](#property)
16c999e8c71134401a78d4d46435517b2271d6ac
mojombo@16c999e8c71134401a78d4d46435517b2271d6ac
mojombo/github-flavored-markdown@16c999e8c71134401a78d4d46435517b2271d6ac

16c999e8c71134401a78d4d46435517b2271d6ac [+](#property)
mojombo@16c999e8c71134401a78d4d46435517b2271d6ac [+](#property)
mojombo/github-flavored-markdown@16c999e8c71134401a78d4d46435517b2271d6ac [+](#property)
#1
mojombo#1
mojombo/github-flavored-markdown#1

#1 [+](#property)
mojombo#1 [+](#property)
mojombo/github-flavored-markdown#1 [+](#property)
Example

reference
reference+

16c999e8c71134401a78d4d46435517b2271d6ac
mojombo@16c999e8c71134401a78d4d46435517b2271d6ac
mojombo/github-flavored-markdown@16c999e8c71134401a78d4d46435517b2271d6ac

16c999e8c71134401a78d4d46435517b2271d6ac +
mojombo@16c999e8c71134401a78d4d46435517b2271d6ac +
mojombo/github-flavored-markdown@16c999e8c71134401a78d4d46435517b2271d6ac +

#1
mojombo#1
mojombo/github-flavored-markdown#1

#1 +
mojombo#1 +
mojombo/github-flavored-markdown#1 +

Resources

Syntax
![GitHub Icon](http://hammerjs.github.io/assets/img/github-icon.png)

![GitHub Icon](http://hammerjs.github.io/assets/img/github-icon.png)[+](#property)

`inline`

`inline`[+](#per-inline-code)

```java
public static void main(String[] args) {
  System.out.println("Hello world!");
}
` ``

```java
public static void main(String[] args) {
  System.out.println("Hello world!");
}
` ``
[{+}](#property)
Example

GitHub Icon

GitHub Icon+

inline
inline+

public static void main(String[] args) {
  System.out.println("Hello world!");
}
public static void main(String[] args) {
  System.out.println("Hello world!");
}

{+}

Content

Syntax
Content paragraph

Content paragraph, the property belongs to the whole paragraph[+](#property)

**bold content**
**bold content with property [+](#property)**

*italic content*
*italic content with property [+](#property)*

~~scratch content~~
~~scratch content with property [+](#property)~~
1. one
   1. two
      1. three

1. one 
   1. two [+](#property)
      1. three 
[{+}](#property)
- previous
- next

- previous
- next [+](#property)
[{+}](#property)
- [x] completed
- [ ] incompleted

- [x] completed [+](#property)
- [ ] incompleted
[{+}](#property)
First | Second
----- | ------
One | Two

First [\|+\|](#property) | Second
----- | ------
One[+](#property) | Two [\_+\_](#property)
[{+}](#property)
Example

Content paragraph

Content paragraph, the property belongs to the whole paragraph+

bold content
bold content with property +

italic content
italic content with property +

scratch content
scratch content with property +

  1. one
    1. two
      1. three

 

  1. one
    1. two +
      1. three {+}

 

  • previous
  • next

 

  • previous
  • next + {+}

 

  • completed
  • incompleted

 

  • completed +
  • incompleted {+}

 

First Second
One Two
First |+| Second
One+ Two _+_
{+}

Notes & Annotations

Syntax
> Blockquotes

> Blockquotes[+](#property)
Example

Blockquotes

Blockquotes+

Comments

[//]: # (comment)
[//]: # (
   Comment content
)

[//]: # (comment[+]\(#property\))
[//]: # (
   Comment content with property[+]\(#property\)
)

Comments are hidden during preview

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment