Skip to content

Commit

Permalink
add ref to contributing and backers
Browse files Browse the repository at this point in the history
  • Loading branch information
TerminalFi authored and FichteFoll committed Oct 29, 2023
1 parent c304546 commit 4c4f6cf
Show file tree
Hide file tree
Showing 6 changed files with 34 additions and 22 deletions.
10 changes: 5 additions & 5 deletions BACKERS.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,14 @@ to make a special mention of Sublime Hq for their generous donation.

- [wbond](https://wbond.net)
- [zchrykng](https://github.com/zchrykng)
- [chitowntiger](xxx)
- [wesbos](https://wesbos.com)
- [kblomqvist](https://kblomqvist.github.io/)
- [lmno](http://toomanyideas.net/)
- [The Sublime Text Tips Newsletter](http://sublimetexttips.com/newsletter?utm_source=twitter&utm_medium=link&utm_content=website_link&utm_campaign=twitter_newsletter_signups)
- [fbdiom](http://sysiv.com)
- [Wickerwaka]
- [Corjuh](http://coryjuhlin.com/)
- [lefoy](http://lefoy.net/)
- [ray hatfield](https://thismight.be%2Foffensive%2F)
- [Tomm0]
- [rhynodesigns](http://rhynodesigns.com/)
- [malcolmbastien](http://facebook.com/profile.php?id=856965639)
- [driutheman](http://ak83.lt/)
Expand All @@ -33,8 +30,6 @@ to make a special mention of Sublime Hq for their generous donation.
- [nathany](http://nathany.com/)
- [reekers](http://blahblah.io)
- [bsansouci](https://github.com/bsansouci)
- [greg]
- [lenards]
- [bdougherty](http://brad.is)
- [bgreenlee](http://footle.org)

Expand Down Expand Up @@ -62,3 +57,8 @@ to make a special mention of Sublime Hq for their generous donation.
- namedtuple
- Punchlinern
- ukwiz
- chitowntiger
- Wickerwaka
- Tomm0
- greg
- lenards
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ from our [fundraiser in 2014 on BountySource][fundraiser]!
## Contributing

This guide is hosted on _Github Pages_ and
built with [Vuepress][].
built with [Vitepress][].
We use [Git LFS][] (large file storage)
for larger artifacts
embedded in the guide,
Expand All @@ -38,19 +38,19 @@ with predefined settings and helpful build systems.
### Building (HTML Preview)

In order to build and preview the docs,
you'll need `yarn`.
you'll need `pnpm`.

1. Install [Yarn](https://classic.yarnpkg.com/en/docs/install/).
1. Install [Pnpm](https://pnpm.io/installation).
2. Run:
- `yarn`
- `yarn dev`
- `pnpm i`
- `pnpm run dev`


[off-docs]: https://sublimetext.com/docs/3
[docs]: https://docs.sublimetext.io/
[trello]: https://trello.com/b/ArLlY4X7/sublime-text-unofficial-documentation
[fundraiser]: https://www.bountysource.com/teams/st-undocs/fundraiser
[Git LFS]: https://git-lfs.github.com/
[Vuepress]: https://vuepress.vuejs.org/
[Vitepress]: https://vitepress.dev/

[issues]: https://github.com/sublimetext-io/docs.sublimetext.io/issues
16 changes: 5 additions & 11 deletions docs.sublimetext.io.sublime-project
Original file line number Diff line number Diff line change
@@ -1,17 +1,11 @@
{
"folders": [
{
{
"path": ".",
"folder_exclude_patterns": [".vuepress/dist"],
"folder_exclude_patterns": [
".vitepress/dist"
],
},
],
"build_systems": [
{
"name": "Check Markdown Links",
"cmd": ["yarn", "check-md"],
"working_dir": "$project_path",
// Use look-ahead trick to match groups in correct order
"file_regex": "(?=.*\\((.*):(\\d+):(\\d+)\\)$)\\s*([^:]+).*"
}
],
"build_systems": [],
}
6 changes: 6 additions & 0 deletions docs/.vitepress/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,12 @@ export default defineConfig({
{ text: "Guide", link: "/guide/", activeMatch: "/guide/" },
{ text: "Reference", link: "/reference/", activeMatch: "/reference/" },
{ text: "Glossary", link: "/glossary", activeMatch: "/glossary" },
{
text: "More", items: [
{ text: "Contributing", link: "/contributing.md", activeMatch: "/contributing" },
{ text: "Backers", link: "/backers.md", activeMatch: "/backers" },
]
}
],
// Social Icons
socialLinks: [
Expand Down
7 changes: 7 additions & 0 deletions docs/BACKERS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: Backers
---

# {{ $frontmatter.title }}

<!--@include: ../BACKERS.md-->
5 changes: 5 additions & 0 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: Contributing
---

<!--@include: ../CONTRIBUTING.md-->

0 comments on commit 4c4f6cf

Please sign in to comment.