8000 setup doc pages · myhololens/coderoad-vscode@ca2d2bb · GitHub
[go: up one dir, main page]
Skip to content

Commit ca2d2bb

Browse files
ShMcKShMcK
committed
setup doc pages
Signed-off-by: shmck <shawn.j.mckay@gmail.com>
1 parent 17c50b4 commit ca2d2bb

16 files changed

+19
-288
lines changed

‎docs/blog/2019-05-28-hola.md

Lines changed: 0 additions & 11 deletions
This file was deleted.

‎docs/blog/2019-05-29-hello-world.md

Lines changed: 0 additions & 17 deletions
This file was deleted.

‎docs/blog/2019-05-30-welcome.md

Lines changed: 0 additions & 13 deletions
This file was deleted.

‎docs-old/tutorials.md renamed to ‎docs/docs/build-tutorial.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
# Tutorial Docs
1+
---
2+
id: build-tutorial
3+
title: Building a Tutorial
4+
sidebar_label: Building a Tutorial
5+
---
26

37
A tutorial is made up of two parts:
48

@@ -133,7 +137,7 @@ That said, anything can be tested. I’ll include some examples below of tests I
133137
##### Equality
134138

135139
Testing equality
136-
Eg. https://github.com/ShMcK/coderoad-tutorial-js-bug-hunter/commit/75b32ebee89853deb3b4dad6aa8654f89bc72cff
140+
Eg. <https://github.com/ShMcK/coderoad-tutorial-js-bug-hunter/commit/75b32ebee89853deb3b4dad6aa8654f89bc72cff>
137141

138142
##### Spy/Listener
139143

@@ -171,7 +175,7 @@ Eg. [setup: useText hook refactor · ShMcK/coderoad-tutorial-tweeter@71deafa ·
171175

172176
When editing markdown, simply edit the markdown and re-run the parser.
173177

174-
When editing code, you'll need to rebase. You can use VSCode as your default editor for Git: https://blog.soltysiak.it/en/2017/01/set-visual-studio-code-as-default-git-editor-and-diff-tool/.
178+
When editing code, you'll need to rebase. You can use VSCode as your default editor for Git: <https://blog.soltysiak.it/en/2017/01/set-visual-studio-code-as-default-git-editor-and-diff-tool/.>
175179

176180
Run rebase from a commit or just "root".
177181

‎docs/docs/doc1.md

Lines changed: 0 additions & 202 deletions
This file was deleted.

‎docs/docs/doc2.md

Lines changed: 0 additions & 6 deletions
This file was deleted.

‎docs/docs/doc3.md

Lines changed: 0 additions & 14 deletions
This file was deleted.

‎docs/docs/mdx.md

Lines changed: 0 additions & 17 deletions
This file was deleted.

‎docs/docs/overview.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
id: overview
3+
title: Overview
4+
sidebar_label: Overview
5+
---
6+
7+
Overview

‎docs/docusaurus.config.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ module.exports = {
1515
},
1616
links: [
1717
{
18-
to: 'docs/doc1',
18+
to: 'docs/overview',
1919
activeBasePath: 'docs',
2020
label: 'Docs',
2121
position: 'left',

‎docs-old/images/continue-tutorial.png renamed to ‎docs/images/continue-tutorial.png

File renamed without changes.

‎docs-old/images/fail-message-in-webview.png renamed to ‎docs/images/fail-message-in-webview.png

File renamed without changes.

‎docs-old/images/traverse-content.png renamed to ‎docs/images/traverse-content.png

File renamed without changes.

‎docs-old/images/tutorial-example.png renamed to ‎docs/images/tutorial-example.png

File renamed without changes.

‎docs/sidebars.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
module.exports = {
22
someSidebar: {
3-
Docusaurus: ['doc1', 'doc2', 'doc3'],
4-
Features: ['mdx'],
3+
Intro: ['overview', 'build-tutorial'],
4+
// Features: ['mdx'],
55
},
6-
};
6+
}

‎docs/src/pages/index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ function Home() {
5151
<div className={styles.buttons}>
5252
<Link
5353
className={classnames('button button--outline button--secondary button--lg', styles.getStarted)}
54-
to={useBaseUrl('docs/doc1')}
54+
to={useBaseUrl('docs/overview')}
5555
>
5656
Get Started
5757
</Link>

0 commit comments

Comments
 (0)
0