Skip to content

Commit bbb120b

Browse files
committed
Fix Sidebar and other minor tweaks
1 parent 44acaac commit bbb120b

26 files changed

+2710
-40
lines changed

.npmrc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
auto-install-peers=true

docs/.vuepress/config.js

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,35 @@ export default defineUserConfig({
1313
}
1414
},
1515
navbar: navbar_en,
16-
sidebar: sidebar_en,
16+
displayAllHeaders: true,
17+
sidebar: [
18+
{
19+
title: 'Documentation Home',
20+
text: 'Documentation Home',
21+
link: '/docs/',
22+
children: [
23+
'/docs/user_guide/',
24+
'/docs/packages/'
25+
]
26+
},
27+
{
28+
title: 'Core Packages',
29+
text: 'Core Packages',
30+
link: '/docs/packages/core/',
31+
initialOpenGroupIndex: 2,
32+
children: [
33+
'/docs/packages/core/atom-languageclient/',
34+
'/docs/packages/core/autocomplete-plus/',
35+
'/docs/packages/core/github/',
36+
'/docs/packages/core/ide-java/'
37+
]
38+
},
39+
{
40+
title: 'Community Packages',
41+
text: 'Community Packages',
42+
link: '/docs/packages/community'
43+
}
44+
],
1745
repo: "https://github.com/pulsar-edit"
1846
})
1947
});

docs/.vuepress/sidebar.js

Lines changed: 14 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,31 @@
11
const sidebar_en = {
22
'/': [
3-
3+
44
],
55
'/docs/user_guide/': [
6-
6+
77
],
8-
'/docs/packages_wiki/': [
9-
{
10-
text: 'Atom-LanguageClient',
11-
link: '/docs/packages_wiki/atom-languageclient/index.md',
12-
children: [
13-
'/docs/packages_wiki/atom-languageclient/list.md',
14-
'/docs/packages_wiki/atom-languageclient/release-process.md'
15-
]
16-
},
8+
'/docs/packages/': [
179
{
18-
text: 'Autocomplete-Plus',
19-
link: '/docs/packages_wiki/autocomplete-plus/index.md',
10+
title: 'Packages',
11+
path: '/docs/packages/',
2012
children: [
21-
'/docs/packages_wiki/autocomplete-plus/autocomplete-providers.md',
22-
'/docs/packages_wiki/autocomplete-plus/provider-api.md',
23-
'/docs/packages_wiki/autocomplete-plus/symbolprovider-config-api.md'
13+
'/docs/packages/core/',
14+
'/docs/packages/community/'
2415
]
25-
},
26-
{
27-
text: 'GitHub',
28-
link: '/docs/packages_wiki/github/index.md',
29-
children: [
30-
'/docs/packages_wiki/github/june-2017.md'
31-
]
32-
},
16+
}
17+
],
18+
'/docs/packages/core/': [
3319
{
34-
text: 'IDE-Java',
35-
link: '/docs/packages_wiki/ide-java/index.md',
20+
title: 'Core Packages',
21+
path: '/docs/packages/core/',
3622
children: [
37-
'/docs/packages_wiki/ide-java/incomplete-classpath-warning.md'
23+
'/docs/packages/core/atom-languageclient'
3824
]
3925
}
40-
],
41-
'/community_packages/': [
42-
4326
],
4427
'/about/': [
45-
28+
4629
]
4730
};
4831

docs/about.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: About Us
3+
path: /about/
4+
---
5+
6+
# About us

docs/about/index.md

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

docs/docs/packages_wiki/index.md renamed to docs/docs/packages/core/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
22
lang: en-us
3-
title: Packages Wiki
4-
description: Wiki Resource for many First Party Packages
3+
title: Core Packages Documentation
4+
description: Wiki Resource for many First Party Packages
55
---
66

7-
# Packages Wiki
7+
# Core Pulsar Packages Documentation
88

99
This aims to be a collection of information about the first-party packages published for Pulsar.
1010

@@ -14,7 +14,7 @@ This means some of this information may be old, or no longer relevant. If it is,
1414

1515
None-the-less the information can still be helpful, and may prove to be valuable. Which is why it has been archived here.
1616

17-
## Archived Wikis
17+
## Archived Wikis
1818

1919
* [Atom-LanguageClient](/docs/packages_wiki/atom-languageclient/index.md)
2020
* [Autocomplete-Plus](/docs/packages_wiki/autocomplete-plus/index.md)

docs/docs/packages/index.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
lang: en-us
3+
title: Packages Documentation
4+
description: Documentation Resource for Packages
5+
---
6+
7+
# Packages Documentation
8+
9+
This aims to be a collection of information about the packages published for the Pulsar Editor.
10+
11+
Secondly, and currently, anything in [Core Packages](/docs/packages/core/) is an archive of every Wiki that was published from the upstream Atom Organization.
12+
13+
This means some of this information may be old, or no longer relevant. If it is, it has been marked as so at the top of the file under a warning.
14+
15+
None-the-less the information can still be helpful, and may prove to be valuable. Which is why it has been archived here.
16+
17+
Lastly, we're keeping a record of [community packages](/docs/packages/community-packages) as well. This is meant to be a record of these. This section should be updated as we get more community contributions of these. The process for adding this will be added at a later date.
18+
19+
20+
## Core Packages
21+
22+
### Updated
23+
* TODO: Add Documentation from updated packages documentation.
24+
25+
### Archived Documentation
26+
27+
* [Atom-LanguageClient](/docs/packages/core/atom-languageclient/index.md)
28+
* [Autocomplete-Plus](/docs/packages/core/autocomplete-plus/index.md)
29+
* [GitHub](/docs/packages/core/github/index.md)
30+
* [IDE-Java](/docs/packages/core/ide-java/index.md)
31+
32+
33+
## Community Packages
34+
* TODO: Add Documentation for Community packages, these can be straight grabs of the readmes for these packages. With possibilty of overrides

docs/index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
lang: en-us
33
title: Home
44
description: Home page for the Pulsar Editor
5+
sidebar: false
6+
home: true
57
---
68

79
# Hello World

package.json

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,19 @@
88
"license": "MIT",
99
"type": "module",
1010
"devDependencies": {
11+
"@vuepress/client": "2.0.0-beta.51",
1112
"remark-lint": "^9.1.1",
13+
"vue": "^3.2.39",
1214
"vuepress": "2.0.0-beta.51"
1315
},
1416
"scripts": {
1517
"docs:dev": "vuepress dev docs",
1618
"docs:build": "vuepress build docs",
1719
"lint": "yarn remark docs/ --use remark-preset-lint-recommended -- use remark-preset-link-markdown-style-guide"
1820
},
19-
"dependencies": {}
21+
"dependencies": {
22+
"fs": "0.0.1-security",
23+
"path": "^0.12.7",
24+
"vuepress-bar": "^0.4.4"
25+
}
2026
}

0 commit comments

Comments
 (0)