mirror of
https://github.com/facebook/docusaurus.git
synced 2025-07-17 16:47:56 +02:00
test: load docs
This commit is contained in:
parent
bf94bf96f8
commit
d80a2555c0
5 changed files with 228 additions and 0 deletions
66
test/load/__fixtures__/simple-docs/foo/bar.md
Normal file
66
test/load/__fixtures__/simple-docs/foo/bar.md
Normal file
|
@ -0,0 +1,66 @@
|
||||||
|
---
|
||||||
|
id: bar
|
||||||
|
title: Bar
|
||||||
|
---
|
||||||
|
|
||||||
|
# Remarkable
|
||||||
|
|
||||||
|
> Experience real-time editing with Remarkable!
|
||||||
|
|
||||||
|
Click the `clear` link to start with a clean slate, or get the `permalink` to share or save your results.
|
||||||
|
|
||||||
|
***
|
||||||
|
|
||||||
|
# h1 Heading
|
||||||
|
## h2 Heading
|
||||||
|
### h3 Heading
|
||||||
|
#### h4 Heading
|
||||||
|
##### h5 Heading
|
||||||
|
###### h6 Heading
|
||||||
|
|
||||||
|
|
||||||
|
## Horizontal Rules
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
***
|
||||||
|
|
||||||
|
***
|
||||||
|
|
||||||
|
|
||||||
|
## Typographic replacements
|
||||||
|
|
||||||
|
Enable typographer option to see result.
|
||||||
|
|
||||||
|
(c) (C) (r) (R) (tm) (TM) (p) (P) +-
|
||||||
|
|
||||||
|
test.. test... test..... test?..... test!....
|
||||||
|
|
||||||
|
!!!!!! ???? ,,
|
||||||
|
|
||||||
|
Remarkable -- awesome
|
||||||
|
|
||||||
|
"Smartypants, double quotes"
|
||||||
|
|
||||||
|
'Smartypants, single quotes'
|
||||||
|
|
||||||
|
|
||||||
|
## Emphasis
|
||||||
|
|
||||||
|
**This is bold text**
|
||||||
|
|
||||||
|
__This is bold text__
|
||||||
|
|
||||||
|
*This is italic text*
|
||||||
|
|
||||||
|
_This is italic text_
|
||||||
|
|
||||||
|
~~Deleted text~~
|
||||||
|
|
||||||
|
Superscript: 19^th^
|
||||||
|
|
||||||
|
Subscript: H~2~O
|
||||||
|
|
||||||
|
++Inserted text++
|
||||||
|
|
||||||
|
==Marked text==
|
77
test/load/__fixtures__/simple-docs/foo/baz.md
Normal file
77
test/load/__fixtures__/simple-docs/foo/baz.md
Normal file
|
@ -0,0 +1,77 @@
|
||||||
|
---
|
||||||
|
id: baz
|
||||||
|
title: baz
|
||||||
|
---
|
||||||
|
|
||||||
|
## Images
|
||||||
|
|
||||||
|

|
||||||
|

|
||||||
|
|
||||||
|
Like links, Images also have a footnote style syntax
|
||||||
|
|
||||||
|
![Alt text][id]
|
||||||
|
|
||||||
|
With a reference later in the document defining the URL location:
|
||||||
|
|
||||||
|
[id]: https://octodex.github.com/images/dojocat.jpg "The Dojocat"
|
||||||
|
|
||||||
|
## Links
|
||||||
|
|
||||||
|
[link text](http://dev.nodeca.com)
|
||||||
|
|
||||||
|
[link with title](http://nodeca.github.io/pica/demo/ "title text!")
|
||||||
|
|
||||||
|
Autoconverted link https://github.com/nodeca/pica (enable linkify to see)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Footnotes
|
||||||
|
|
||||||
|
Footnote 1 link[^first].
|
||||||
|
|
||||||
|
Footnote 2 link[^second].
|
||||||
|
|
||||||
|
Inline footnote^[Text of inline footnote] definition.
|
||||||
|
|
||||||
|
Duplicated footnote reference[^second].
|
||||||
|
|
||||||
|
[^first]: Footnote **can have markup**
|
||||||
|
|
||||||
|
and multiple paragraphs.
|
||||||
|
|
||||||
|
[^second]: Footnote text.
|
||||||
|
|
||||||
|
|
||||||
|
## Definition lists
|
||||||
|
|
||||||
|
Term 1
|
||||||
|
|
||||||
|
: Definition 1
|
||||||
|
with lazy continuation.
|
||||||
|
|
||||||
|
Term 2 with *inline markup*
|
||||||
|
|
||||||
|
: Definition 2
|
||||||
|
|
||||||
|
{ some code, part of Definition 2 }
|
||||||
|
|
||||||
|
Third paragraph of definition 2.
|
||||||
|
|
||||||
|
_Compact style:_
|
||||||
|
|
||||||
|
Term 1
|
||||||
|
~ Definition 1
|
||||||
|
|
||||||
|
Term 2
|
||||||
|
~ Definition 2a
|
||||||
|
~ Definition 2b
|
||||||
|
|
||||||
|
|
||||||
|
## Abbreviations
|
||||||
|
|
||||||
|
This is HTML abbreviation example.
|
||||||
|
|
||||||
|
It converts "HTML", but keep intact partial entries like "xxxHTMLyyy" and so on.
|
||||||
|
|
||||||
|
*[HTML]: Hyper Text Markup Language
|
40
test/load/__fixtures__/simple-docs/hello.md
Normal file
40
test/load/__fixtures__/simple-docs/hello.md
Normal file
|
@ -0,0 +1,40 @@
|
||||||
|
---
|
||||||
|
id: hello
|
||||||
|
title: Hello, World !
|
||||||
|
---
|
||||||
|
|
||||||
|
Hi, Endilie here :)
|
||||||
|
|
||||||
|
## Blockquotes
|
||||||
|
|
||||||
|
> Blockquotes can also be nested...
|
||||||
|
>> ...by using additional greater-than signs right next to each other...
|
||||||
|
> > > ...or with spaces between arrows.
|
||||||
|
|
||||||
|
|
||||||
|
## Lists
|
||||||
|
|
||||||
|
Unordered
|
||||||
|
|
||||||
|
+ Create a list by starting a line with `+`, `-`, or `*`
|
||||||
|
+ Sub-lists are made by indenting 2 spaces:
|
||||||
|
- Marker character change forces new list start:
|
||||||
|
* Ac tristique libero volutpat at
|
||||||
|
+ Facilisis in pretium nisl aliquet
|
||||||
|
- Nulla volutpat aliquam velit
|
||||||
|
+ Very easy!
|
||||||
|
|
||||||
|
Ordered
|
||||||
|
|
||||||
|
1. Lorem ipsum dolor sit amet
|
||||||
|
2. Consectetur adipiscing elit
|
||||||
|
3. Integer molestie lorem at massa
|
||||||
|
|
||||||
|
|
||||||
|
1. You can use sequential numbers...
|
||||||
|
1. ...or keep all the numbers as `1.`
|
||||||
|
|
||||||
|
Start numbering with offset:
|
||||||
|
|
||||||
|
57. foo
|
||||||
|
1. bar
|
24
test/load/__snapshots__/docs.test.js.snap
Normal file
24
test/load/__snapshots__/docs.test.js.snap
Normal file
|
@ -0,0 +1,24 @@
|
||||||
|
// Jest Snapshot v1, https://goo.gl/fbAQLP
|
||||||
|
|
||||||
|
exports[`loadDocs simple docs 1`] = `
|
||||||
|
Array [
|
||||||
|
Object {
|
||||||
|
"id": "hello",
|
||||||
|
"path": "/hello",
|
||||||
|
"source": "hello.md",
|
||||||
|
"title": "Hello, World !",
|
||||||
|
},
|
||||||
|
Object {
|
||||||
|
"id": "bar",
|
||||||
|
"path": "/foo/bar",
|
||||||
|
"source": "foo/bar.md",
|
||||||
|
"title": "Bar",
|
||||||
|
},
|
||||||
|
Object {
|
||||||
|
"id": "baz",
|
||||||
|
"path": "/foo/baz",
|
||||||
|
"source": "foo/baz.md",
|
||||||
|
"title": "baz",
|
||||||
|
},
|
||||||
|
]
|
||||||
|
`;
|
21
test/load/docs.test.js
Normal file
21
test/load/docs.test.js
Normal file
|
@ -0,0 +1,21 @@
|
||||||
|
import loadDocs from '@lib/load/docs.js';
|
||||||
|
import path from 'path';
|
||||||
|
|
||||||
|
describe('loadDocs', () => {
|
||||||
|
test('simple docs', async () => {
|
||||||
|
const docsDir = path.join(__dirname, '__fixtures__', 'simple-docs');
|
||||||
|
const docsData = await loadDocs(docsDir);
|
||||||
|
expect(docsData).toMatchSnapshot();
|
||||||
|
expect(docsData).not.toBeNull();
|
||||||
|
});
|
||||||
|
|
||||||
|
test('no docs', async () => {
|
||||||
|
const nonExistingDocsDir = path.join(
|
||||||
|
__dirname,
|
||||||
|
'__fixtures__',
|
||||||
|
'nonExistingDocs'
|
||||||
|
);
|
||||||
|
const docsData = await loadDocs(nonExistingDocsDir);
|
||||||
|
expect(docsData).toEqual([]);
|
||||||
|
});
|
||||||
|
});
|
Loading…
Add table
Add a link
Reference in a new issue