mirror of
https://github.com/snachodog/just-the-docs.git
synced 2025-04-10 14:01:22 -06:00
dd0b814bfd
* Remove `jekyll-default-layout` plugin * Move docs/navigation-structure to docs/navigation * Fix uses of line-nos in md files * Update CHANGELOG.md --------- Co-authored-by: Matt Wang <matt@matthewwang.me>
326 lines
7.1 KiB
Markdown
326 lines
7.1 KiB
Markdown
---
|
|
title: Markdown kitchen sink
|
|
nav_order: 99
|
|
---
|
|
|
|
<button class="btn js-toggle-dark-mode">Preview dark color scheme</button>
|
|
|
|
<script>
|
|
const toggleDarkMode = document.querySelector('.js-toggle-dark-mode');
|
|
|
|
jtd.addEvent(toggleDarkMode, 'click', function(){
|
|
if (jtd.getTheme() === 'dark') {
|
|
jtd.setTheme('light');
|
|
toggleDarkMode.textContent = 'Preview dark color scheme';
|
|
} else {
|
|
jtd.setTheme('dark');
|
|
toggleDarkMode.textContent = 'Return to the light side';
|
|
}
|
|
});
|
|
</script>
|
|
|
|
Text can be **bold**, _italic_, or ~~strikethrough~~.
|
|
|
|
[Link to another page]({{site.baseurl}}/).
|
|
|
|
There should be whitespace between paragraphs.
|
|
|
|
There should be whitespace between paragraphs. We recommend including a README, or a file with information about your project.
|
|
|
|
# [](#header-1)Header 1
|
|
|
|
This is a normal paragraph following a header. GitHub is a code hosting platform for version control and collaboration. It lets you and others work together on projects from anywhere.
|
|
|
|
## [](#header-2)Header 2
|
|
|
|
> This is a blockquote following a header.
|
|
>
|
|
> When something is important enough, you do it even if the odds are not in your favor.
|
|
|
|
### [](#header-3)Header 3
|
|
|
|
```js
|
|
// Javascript code with syntax highlighting.
|
|
var fun = function lang(l) {
|
|
dateformat.i18n = require('./lang/' + l)
|
|
return true;
|
|
}
|
|
```
|
|
|
|
```ruby
|
|
# Ruby code with syntax highlighting
|
|
GitHubPages::Dependencies.gems.each do |gem, version|
|
|
s.add_dependency(gem, "= #{version}")
|
|
end
|
|
```
|
|
|
|
#### [](#header-4-with-code-not-transformed)Header 4 `with code not transformed`
|
|
|
|
* This is an unordered list following a header.
|
|
* This is an unordered list following a header.
|
|
* This is an unordered list following a header.
|
|
|
|
##### [](#header-5)Header 5
|
|
|
|
1. This is an ordered list following a header.
|
|
2. This is an ordered list following a header.
|
|
3. This is an ordered list following a header.
|
|
|
|
###### [](#header-6)Header 6
|
|
|
|
[This is a very long link which wraps and therefore doesn't overflow
|
|
even when it comes at the beginning](.) of the line.
|
|
|
|
- [This is a very long link which wraps and therefore doesn't overflow the line
|
|
when used first in an item ](.) in a list.
|
|
|
|
| head1 | head two | three |
|
|
|:-------------|:------------------|:------|
|
|
| ok | good swedish fish | nice |
|
|
| out of stock | good and plenty | nice |
|
|
| ok | good `oreos` | hmm |
|
|
| ok | good `zoute` drop | yumm |
|
|
|
|
### There's a horizontal rule below this.
|
|
|
|
* * *
|
|
|
|
### Here is an unordered list:
|
|
|
|
* Item foo
|
|
* Item bar
|
|
* Item baz
|
|
* Item zip
|
|
|
|
### And an ordered list:
|
|
|
|
1. Item one
|
|
1. Item two
|
|
1. Item three
|
|
1. Item four
|
|
|
|
### And an ordered list, continued:
|
|
|
|
1. Item one
|
|
1. Item two
|
|
|
|
Some text
|
|
|
|
{:style="counter-reset:none"}
|
|
1. Item three
|
|
1. Item four
|
|
|
|
### And an ordered list starting from 42:
|
|
|
|
{:style="counter-reset:step-counter 41"}
|
|
1. Item 42
|
|
1. Item 43
|
|
1. Item 44
|
|
|
|
### And a nested list:
|
|
|
|
- level 1 item
|
|
- level 2 item
|
|
- level 2 item
|
|
- level 3 item
|
|
- level 3 item
|
|
- level 1 item
|
|
- level 2 item
|
|
- level 2 item
|
|
- level 2 item
|
|
- level 1 item
|
|
- level 2 item
|
|
- level 2 item
|
|
- level 1 item
|
|
|
|
### Nesting an ol in ul in an ol
|
|
|
|
- level 1 item (ul)
|
|
1. level 2 item (ol)
|
|
1. level 2 item (ol)
|
|
- level 3 item (ul)
|
|
- level 3 item (ul)
|
|
- level 1 item (ul)
|
|
1. level 2 item (ol)
|
|
1. level 2 item (ol)
|
|
- level 3 item (ul)
|
|
- level 3 item (ul)
|
|
1. level 4 item (ol)
|
|
1. level 4 item (ol)
|
|
- level 3 item (ul)
|
|
- level 3 item (ul)
|
|
- level 1 item (ul)
|
|
|
|
### And a task list
|
|
|
|
- [ ] Hello, this is a TODO item
|
|
- [ ] Hello, this is another TODO item
|
|
- [x] Goodbye, this item is done
|
|
|
|
### Nesting task lists
|
|
|
|
- [ ] level 1 item (task)
|
|
- [ ] level 2 item (task)
|
|
- [ ] level 2 item (task)
|
|
- [ ] level 1 item (task)
|
|
- [ ] level 1 item (task)
|
|
|
|
### Nesting a ul in a task list
|
|
|
|
- [ ] level 1 item (task)
|
|
- level 2 item (ul)
|
|
- level 2 item (ul)
|
|
- [ ] level 1 item (task)
|
|
- [ ] level 1 item (task)
|
|
|
|
### Nesting a task list in a ul
|
|
|
|
- level 1 item (ul)
|
|
- [ ] level 2 item (task)
|
|
- [ ] level 2 item (task)
|
|
- level 1 item (ul)
|
|
- level 1 item (ul)
|
|
|
|
### Small image
|
|
|
|
|
|
|
|
### Large image
|
|
|
|
|
|
|
|
"[Wroclaw University Library digitizing rare archival texts](https://www.flickr.com/photos/97810305@N08/9401451269)" by [j_cadmus](https://www.flickr.com/photos/97810305@N08) is marked with [CC BY 2.0](https://creativecommons.org/licenses/by/2.0/?ref=openverse).
|
|
|
|
### Labels
|
|
|
|
I'm a label
|
|
{: .label }
|
|
|
|
blue
|
|
{: .label .label-blue }
|
|
green
|
|
{: .label .label-green }
|
|
purple
|
|
{: .label .label-purple }
|
|
yellow
|
|
{: .label .label-yellow }
|
|
red
|
|
{: .label .label-red }
|
|
|
|
**bold**
|
|
{: .label }
|
|
*italic*
|
|
{: .label }
|
|
***bold + italic***
|
|
{: .label }
|
|
|
|
### Definition lists can be used with HTML syntax.
|
|
|
|
<dl>
|
|
<dt>Name</dt>
|
|
<dd>Godzilla</dd>
|
|
<dt>Born</dt>
|
|
<dd>1952</dd>
|
|
<dt>Birthplace</dt>
|
|
<dd>Japan</dd>
|
|
<dt>Color</dt>
|
|
<dd>Green</dd>
|
|
</dl>
|
|
|
|
#### Multiple description terms and values
|
|
|
|
Term
|
|
: Brief description of Term
|
|
|
|
Longer Term
|
|
: Longer description of Term,
|
|
possibly more than one line
|
|
|
|
Term
|
|
: First description of Term,
|
|
possibly more than one line
|
|
|
|
: Second description of Term,
|
|
possibly more than one line
|
|
|
|
Term1
|
|
Term2
|
|
: Single description of Term1 and Term2,
|
|
possibly more than one line
|
|
|
|
Term1
|
|
Term2
|
|
: First description of Term1 and Term2,
|
|
possibly more than one line
|
|
|
|
: Second description of Term1 and Term2,
|
|
possibly more than one line
|
|
|
|
### More code
|
|
|
|
```python{% raw %}
|
|
def dump_args(func):
|
|
"This decorator dumps out the arguments passed to a function before calling it"
|
|
argnames = func.func_code.co_varnames[:func.func_code.co_argcount]
|
|
fname = func.func_name
|
|
def echo_func(*args,**kwargs):
|
|
print fname, ":", ', '.join(
|
|
'%s=%r' % entry
|
|
for entry in zip(argnames,args) + kwargs.items())
|
|
return func(*args, **kwargs)
|
|
return echo_func
|
|
|
|
@dump_args
|
|
def f1(a,b,c):
|
|
print a + b + c
|
|
|
|
f1(1, 2, 3)
|
|
|
|
def precondition(precondition, use_conditions=DEFAULT_ON):
|
|
return conditions(precondition, None, use_conditions)
|
|
|
|
def postcondition(postcondition, use_conditions=DEFAULT_ON):
|
|
return conditions(None, postcondition, use_conditions)
|
|
|
|
class conditions(object):
|
|
__slots__ = ('__precondition', '__postcondition')
|
|
|
|
def __init__(self, pre, post, use_conditions=DEFAULT_ON):
|
|
if not use_conditions:
|
|
pre, post = None, None
|
|
|
|
self.__precondition = pre
|
|
self.__postcondition = post
|
|
{% endraw %}```
|
|
|
|
```
|
|
Long, single-line code blocks should not wrap. They should horizontally scroll if they are too long. This line should be long enough to demonstrate this.
|
|
```
|
|
|
|
### Mermaid Diagrams
|
|
|
|
The following code is displayed as a diagram only when a `mermaid` key supplied in `_config.yml`.
|
|
|
|
```mermaid
|
|
graph TD;
|
|
A-->B;
|
|
A-->C;
|
|
B-->D;
|
|
C-->D;
|
|
```
|
|
|
|
### Collapsed Section
|
|
|
|
The following uses the [`<details>`](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/organizing-information-with-collapsed-sections) tag to create a collapsed section.
|
|
|
|
<details markdown="block">
|
|
<summary>Shopping list (click me!)</summary>
|
|
|
|
This is content inside a `<details>` dropdown.
|
|
|
|
- [ ] Apples
|
|
- [ ] Oranges
|
|
- [ ] Milk
|
|
|
|
</details>
|