Skip to content

Commit 9f33b65

Browse files
Add sitemap and robots file, continue fixing sidebar data
1 parent afe12b4 commit 9f33b65

File tree

7 files changed

+94
-26
lines changed

7 files changed

+94
-26
lines changed

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,8 @@ Switch links with `@images` to `/img`
3636
The biggest aspects of this that still have to be completed:
3737

3838
- [ ] Finalize CSS implementations
39-
- [ ] Create all EJS templates needed
40-
- [ ] Create collections and automatically create collection views on summary pages
39+
- [X] Create all EJS templates needed
40+
- [X] Create collections and automatically create collection views on summary pages
4141
- [ ] Implement Dark Mode
4242
- [ ] Add all relevant documentation
4343
- [ ] Update **ALL** Links!

data/default.js

+2
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,6 @@ module.exports = {
44
// everything still works when rendering EJS
55
title: "Pulsar Documentation",
66
layout: "doc.ejs", // Have the default view be the one used most often
7+
changefreq: "monthly",
8+
url: "https://docs.pulsar-edit.dev"
79
};
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,54 @@
11
{
22
"sidebar": [
33
{
4-
"text": "Find and Replace"
4+
"text": "Find and Replace",
5+
"link": "find-and-replace",
6+
"summary": "Find and replace text"
57
},
68
{
7-
"text": "Snippets"
9+
"text": "Snippets",
10+
"link": "snippets",
11+
"summary": "Expand text"
812
},
913
{
10-
"text": "Autocomplete"
14+
"text": "Autocomplete",
15+
"link": "autocomplete",
16+
"summary": "Work with suggested autocompletions as you type"
1117
},
1218
{
13-
"text": "Folding"
19+
"text": "Folding",
20+
"link": "folding",
21+
"summary": "Collapse text in a file"
1422
},
1523
{
16-
"text": "Panes"
24+
"text": "Panes",
25+
"link": "panes",
26+
"summary": "Understand the layout within Pulsar"
1727
},
1828
{
19-
"text": "Grammar"
29+
"text": "Grammar",
30+
"link": "grammar",
31+
"summary": "Learn how text receives Syntax Highlighting"
2032
},
2133
{
22-
"text": "Version Control in Pulsar"
34+
"text": "Version Control in Pulsar",
35+
"link": "version-control-in-pulsar",
36+
"summary": "Keep a history of your files changes"
2337
},
2438
{
25-
"text": "GitHub Package"
39+
"text": "GitHub Package",
40+
"link": "github-package",
41+
"summary": "Integrate directly within GitHub"
2642
},
2743
{
28-
"text": "Spell Check"
44+
"text": "Spell Check",
45+
"link": "spell-check",
46+
"summary": "Fix mis-spellings in your text"
2947
},
3048
{
31-
"text": "Previews"
49+
"text": "Previews",
50+
"link": "previews",
51+
"summary": "See what your prose files look like rendered"
3252
}
3353
]
34-
3554
}

docs/customize-pulsar/customize-pulsar.11tydata.json

+27-9
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,49 @@
11
{
22
"sidebar": [
33
{
4-
"text": "Creating your own Snippets"
4+
"text": "Creating your own Snippets",
5+
"link": "creating-your-own-snippets",
6+
"summary": "Guide to create a custom Snippet"
57
},
68
{
7-
"text": "Configuring with CSON"
9+
"text": "Configuring with CSON",
10+
"link": "configuring-with-cson",
11+
"summary": "Utilize CSON to configure Pulsar"
812
},
913
{
10-
"text": "Style Tweaks"
14+
"text": "Style Tweaks",
15+
"link": "style-tweaks",
16+
"summary": "How to modify the look of Pulsar"
1117
},
1218
{
13-
"text": "Customizing Keybindings"
19+
"text": "Customizing Keybindings",
20+
"link": "customizing-keybindings",
21+
"summary": "Change what keyboard shortcuts do in Pulsar"
1422
},
1523
{
16-
"text": "Global Configuration Settings"
24+
"text": "Global Configuration Settings",
25+
"link": "global-configuration-settings",
26+
"summary": "Introduction of Pulsar's Settings"
1727
},
1828
{
19-
"text": "Language Specific Configuration Settings"
29+
"text": "Language Specific Configuration Settings",
30+
"link": "language-specific-configuration-settings",
31+
"summary": "Scope Settings on a per language basis"
2032
},
2133
{
22-
"text": "Customizing Language Recognition"
34+
"text": "Customizing Language Recognition",
35+
"link": "customizing-language-recognition",
36+
"summary": "Change the grammar chosen for a file"
2337
},
2438
{
25-
"text": "Controlling where customization is stored"
39+
"text": "Controlling where customization is stored",
40+
"link": "controlling-where-customization-is-stored",
41+
"summary": "Modify where your configuration data lives"
2642
},
2743
{
28-
"text": "The Init File"
44+
"text": "The Init File",
45+
"link": "the-init-file",
46+
"summary": "Learn the power of the Init file"
2947
}
3048
]
3149

docs/hacking-pulsar/hacking-pulsar.11tydata.json

+12-4
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,24 @@
11
{
22
"sidebar": [
33
{
4-
"text": "Building Pulsar"
4+
"text": "Building Pulsar",
5+
"link": "building-pulsar",
6+
"summary": "Build Pulsar from source code"
57
},
68
{
7-
"text": "Using PPM"
9+
"text": "Using PPM",
10+
"link": "using-ppm",
11+
"summary": "Learn the bundled tool PPM"
812
},
913
{
10-
"text": "Hacking on the Core"
14+
"text": "Hacking on the Core",
15+
"link": "hacking-on-the-core",
16+
"summary": "The basics about preparing Pulsar to modify core functionality"
1117
},
1218
{
13-
"text": "Tools of the Trade"
19+
"text": "Tools of the Trade",
20+
"link": "tools-of-the-trade",
21+
"summary": "The baseline knowledge and tools you should have to start hacking"
1422
}
1523
]
1624

docs/robots.njk

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
permalink: /robots.txt
3+
eleventyExcludeFromCollections: true
4+
---
5+
Sitemap: {{ default.url }}/sitemap.xml
6+
User-agent: *
7+
Disallow: /

docs/sitemap.njk

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
permalink: /sitemap.xml
3+
eleventyExcludeFromCollections: true
4+
---
5+
<?xml version="1.0" encoding="utf-8"?>
6+
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
7+
{% for page in collections.all %}
8+
<url>
9+
<loc>{{ default.url }}{{ page.url | url }}</loc>
10+
<lastmod>{{ page.date.toISOString() }}</lastmod>
11+
<changefreq>{{ page.data.changefreq if page.data.changefreq else default.changefreq }}</changefreq>
12+
</url>
13+
{% endfor %}
14+
</urlset>

0 commit comments

Comments
 (0)