From 3e87a6b75cf3cc9c4f744da3b160dbb295bf0ea4 Mon Sep 17 00:00:00 2001 From: cab-mikee Date: Fri, 27 Dec 2024 19:48:08 +0800 Subject: [PATCH] docs: enhance docs --- docs/.vitepress/config.ts | 26 +++- docs/license.md | 21 +++ docs/partners.md | 8 ++ docs/postcardware.md | 11 ++ docs/public/images/logo-white-transparent.svg | 4 + docs/showcase.md | 3 + docs/sponsors.md | 131 ++++++++++++++++++ 7 files changed, 199 insertions(+), 5 deletions(-) create mode 100644 docs/license.md create mode 100644 docs/partners.md create mode 100644 docs/postcardware.md create mode 100644 docs/public/images/logo-white-transparent.svg create mode 100644 docs/showcase.md create mode 100644 docs/sponsors.md diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index acc2b68..457d881 100644 --- a/docs/.vitepress/config.ts +++ b/docs/.vitepress/config.ts @@ -19,11 +19,11 @@ const analyticsHead: HeadConfig[] = [ ] const nav = [ + { text: 'News', link: 'https://stacksjs.org/news' }, { text: 'Changelog', link: 'https://github.com/stacksjs/localtunnels/blob/main/CHANGELOG.md', }, - // { text: 'Blog', link: 'https://updates.ow3.org' }, { text: 'Resources', items: [ @@ -31,6 +31,7 @@ const nav = [ { text: 'Sponsors', link: '/sponsors' }, { text: 'Partners', link: '/partners' }, { text: 'Postcardware', link: '/postcardware' }, + { text: 'License', link: '/license' }, { items: [ { @@ -51,18 +52,22 @@ const sidebar = [ { text: 'Get Started', items: [ - { text: 'Introduction', link: '/intro' }, + { text: 'Intro', link: '/intro' }, { text: 'Install', link: '/install' }, { text: 'Usage', link: '/usage' }, ], }, + { text: 'Showcase', link: '/Showcase' }, ] +const description = 'A simple and smart tunneling alternative. Without or with self-hosting.' +const title = 'localtunnels | ' + description + export default withPwa( defineConfig({ lang: 'en-US', title: 'localtunnels', - description: 'A simple and smart tunneling alternative. Without or with self-hosting.', + description, lastUpdated: true, cleanUrls: true, metaChunk: true, @@ -71,9 +76,17 @@ export default withPwa( ['link', { rel: 'icon', type: 'image/svg+xml', href: './images/logo-mini.svg' }], ['link', { rel: 'icon', type: 'image/png', href: './images/logo.png' }], ['meta', { name: 'theme-color', content: '#0A0ABC' }], + ['meta', { name: 'title', content: title }], + ['meta', { name: 'description', content: description }], + ['meta', { name: 'author', content: 'Stacks.js, Inc.' }], + ['meta', { + name: 'tags', + content: 'local, tunnel, localtunnels, stacksjs, domain, https', + }], ['meta', { property: 'og:type', content: 'website' }], ['meta', { property: 'og:locale', content: 'en' }], - ['meta', { property: 'og:title', content: 'localtunnels | A simple and smart tunneling alternative. Without or with self-hosting.' }], + ['meta', { property: 'og:title', content: title }], + ['meta', { property: 'og:description', content: description }], ['meta', { property: 'og:site_name', content: 'localtunnels' }], ['meta', { property: 'og:image', content: './images/og-image.jpg' }], ['meta', { property: 'og:url', content: 'https://localtunnel.sh/' }], @@ -82,7 +95,10 @@ export default withPwa( ], themeConfig: { - logo: './images/logo-transparent.svg', + logo: { + light: './images/logo-transparent.svg', + dark: './images/logo-white-transparent.svg', + }, nav, sidebar, diff --git a/docs/license.md b/docs/license.md new file mode 100644 index 0000000..6d46d1d --- /dev/null +++ b/docs/license.md @@ -0,0 +1,21 @@ +# MIT License + +Copyright (c) 2024 Stacks.js + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/docs/partners.md b/docs/partners.md new file mode 100644 index 0000000..d0d6180 --- /dev/null +++ b/docs/partners.md @@ -0,0 +1,8 @@ +# Partners + +The following companies and organizations are supporting Stacks development through partnerships: + +- [JetBrains](https://www.jetbrains.com/) +- [The Solana Foundation](https://solana.com/) + +If you are interested in becoming a partner, please reach out to us. diff --git a/docs/postcardware.md b/docs/postcardware.md new file mode 100644 index 0000000..2e71a10 --- /dev/null +++ b/docs/postcardware.md @@ -0,0 +1,11 @@ +# Postcardware + +Two things are true: Stacks OSS will always stay open-source, and we do love to receive postcards from wherever Stacks is used! 🌍 + +_We also publish them on our website._ + +## Address + +Our address in the US is: + +Stacks.js, 12665 Village Ln #2306, Playa Vista, CA 90094, United States 🌎 diff --git a/docs/public/images/logo-white-transparent.svg b/docs/public/images/logo-white-transparent.svg new file mode 100644 index 0000000..a5847dd --- /dev/null +++ b/docs/public/images/logo-white-transparent.svg @@ -0,0 +1,4 @@ + + + + diff --git a/docs/showcase.md b/docs/showcase.md new file mode 100644 index 0000000..3ec0faf --- /dev/null +++ b/docs/showcase.md @@ -0,0 +1,3 @@ +# Showcase + +Here are all the cool projects that people have built using `localtunnels`. If you have something you’d like to share, please share it with us in any way _(on Discord, Social Media, or via a PR, etc.)_, and we’ll add it here. diff --git a/docs/sponsors.md b/docs/sponsors.md new file mode 100644 index 0000000..f30e981 --- /dev/null +++ b/docs/sponsors.md @@ -0,0 +1,131 @@ +# Become a Stacks.js Sponsor + +Stacks.js is an MIT licensed open source project and completely free to use. The tremendous amount of effort needed to maintain such a large ecosystem and develop new features for the project is only made sustainable thanks to the generous financial backing of our sponsors. + +## How to Sponsor + +Sponsorships can be done via [GitHub Sponsors](https://github.com/sponsors/chrisbbreuer) or [OpenCollective](https://opencollective.com/stacksjs). Invoices can be obtained via GitHub's payment system. Both monthly-recurring sponsorships and one-time donations are accepted. Recurring sponsorships are entitled to logo placements as specified in Sponsorship Tiers. + +If you have questions regarding tiers, payment logistics, or sponsor exposure data, please reach out to . + +The following companies and organizations are supporting Stacks development through sponsorships: + +## Sponsoring Stacks as a Business + +Sponsoring Stacks gives you developer exposure around the world through our website and GitHub project READMEs. This not only directly generates leads, but also improves your brand recognition as a business that cares about Open Source. This is an intangible but extremely important asset for companies building products for developers, as it improves your conversion rate. + +If you are using Stacks to build a revenue-generating product, it makes business sense to sponsor Stacks's development: it ensures the project that your product relies on stays healthy and actively maintained. The exposure and positive brand image in the Stacks community also makes it easier to attract and recruit Stacks developers. + +If you are building a product where your target customers are developers, you will gain high quality traffic through the sponsorship exposure, since all our visitors are developers. The sponsorship also builds brand recognition and improves conversion. + +## Sponsoring Stacks as an Individual + +If you are an individual user and have enjoyed the productivity of using Stacks, consider donating as a sign of appreciation - like buying us coffee once in a while. Many of our team members accept sponsorships and donations via GitHub Sponsors. Look for the "Sponsor" button on each team member's profile on our [team page](https://stacksjs-docs.netlify.app/team). + +You can also try to convince your employer to sponsor Stacks as a business. This may not be easy, but business sponsorships typically make a much larger impact on the sustainability of OSS projects than individual donations, so you will help us much more if you succeed. + +## Tier Benefits + +- ***Global Special Sponsor*** + - Limited to one sponsor globally. Currently vacant. [Get in touch!](mailto:sponsors@stacksjs.org) + - *(Exclusive)* Above the fold logo placement on the front page of [stacksjs.org](https://stacksjs.org). + - *(Exclusive)* Special shoutout and regular retweets of major product launches via Stacks's official social accounts. + - Most prominent logo placement in all locations from tiers below. + +___ + +- **Diamond (USD$2,500/mo):** + - Prominent logo placement on the front page of [stacksjs.org](https://stacksjs.org), [docs.stacksjs.org](https://docs.stacksjs.org), [tlsx.sh](https://tlsx.sh), [rpx](https://reverse-proxy.sh), [dtsx](https://github.com/stacksjs/dtsx), [localtunnels](https://localtunnel.sh), [bunfig](https://bunfig.netlify.app/), [vite-plugin-local](https://vite-plugin-local.netlify.app/), [ts-collect](https://ts-collect.netlify.app/), [ts-spreadsheets](https://ts-spreadsheets.netlify.app/). + - Prominent logo placement in sidebar of all content pages. + - Prominent logo placement in the README of >70x `stacksjs/core` repos, `stacksjs/stacks`, `tlsx`, `rpx`, `dtsx`, `localtunnels`, `bunfig`, `vite-plugin-local`, `ts-collect`, `ts-spreadsheets`, and few others. + +___ + +- **Platinum (USD$1,000/mo):** + - Large logo placement on the front page of [stacksjs.org](https://stacksjs.org), [docs.stacksjs.org](https://docs.stacksjs.org), [tlsx.sh](https://tlsx.sh), [rpx](https://reverse-proxy.sh), [dtsx](https://github.com/stacksjs/dtsx), [localtunnels](https://localtunnel.sh), [bunfig](https://bunfig.netlify.app/), [vite-plugin-local](https://vite-plugin-local.netlify.app/), [ts-collect](https://ts-collect.netlify.app/), [ts-spreadsheets](https://ts-spreadsheets.netlify.app/). + - Large logo placement in the README of >70x `stacksjs/core` repos, `stacksjs/stacks`, `tlsx`, `rpx`, `dtsx`, `localtunnels`, `bunfig`, `vite-plugin-local`, `ts-collect`, `ts-spreadsheets`, and few others. + +___ + +- **Double Gold (USD$500/mo):** + - Large logo placement on the front page of [stacksjs.org](https://stacksjs.org), [docs.stacksjs.org](https://docs.stacksjs.org), [tlsx.sh](https://tlsx.sh), [rpx](https://reverse-proxy.sh), [dtsx](https://github.com/stacksjs/dtsx), [localtunnels](https://localtunnel.sh), [bunfig](https://bunfig.netlify.app/), [vite-plugin-local](https://vite-plugin-local.netlify.app/), [ts-collect](https://ts-collect.netlify.app/), [ts-spreadsheets](https://ts-spreadsheets.netlify.app/). + - Large logo placement in the README of >70x `stacksjs/core` repos, `stacksjs/stacks`, `tlsx`, `rpx`, `dtsx`, `localtunnels`, `bunfig`, `vite-plugin-local`, `ts-collect`, `ts-spreadsheets`, and few others. + +___ + +- **Gold (USD$250/mo):** + - Large logo placement on the front page of [stacksjs.org](https://stacksjs.org), [docs.stacksjs.org](https://docs.stacksjs.org), [tlsx.sh](https://tlsx.sh), [rpx](https://reverse-proxy.sh), [dtsx](https://github.com/stacksjs/dtsx), [localtunnels](https://localtunnel.sh), [bunfig](https://bunfig.netlify.app/), [vite-plugin-local](https://vite-plugin-local.netlify.app/), [ts-collect](https://ts-collect.netlify.app/), [ts-spreadsheets](https://ts-spreadsheets.netlify.app/). + - Large logo placement in the README of >70x `stacksjs/core` repos, `stacksjs/stacks`, `tlsx`, `rpx`, `dtsx`, `localtunnels`, `bunfig`, `vite-plugin-local`, `ts-collect`, `ts-spreadsheets`, and few others. + +___ + +- **Silver (USD$100/mo):** + - Medium logo placement on the front page of [stacksjs.org](https://stacksjs.org), [docs.stacksjs.org](https://docs.stacksjs.org), [tlsx.sh](https://tlsx.sh), [rpx](https://reverse-proxy.sh), [dtsx](https://github.com/stacksjs/dtsx), [localtunnels](https://localtunnel.sh), [bunfig](https://bunfig.netlify.app/), [vite-plugin-local](https://vite-plugin-local.netlify.app/), [ts-collect](https://ts-collect.netlify.app/), [ts-spreadsheets](https://ts-spreadsheets.netlify.app/). + - Medium logo placement in the README of >70x `stacksjs/core` repos, `stacksjs/stacks`, `tlsx`, `rpx`, `dtsx`, `localtunnels`, `bunfig`, `vite-plugin-local`, `ts-collect`, `ts-spreadsheets`, and few others. + - Medium logo placement in the `BACKERS.md` file of>70x `stacksjs/core` repos, `stacksjs/stacks`, `tlsx`, `rpx`, `dtsx`, `localtunnels`, `bunfig`, `vite-plugin-local`, `ts-collect`, `ts-spreadsheets`, and few others. + +___ + +- **Bronze (50/mo):** + - Small logo placement on the front page of [stacksjs.org](https://stacksjs.org), [docs.stacksjs.org](https://docs.stacksjs.org), [tlsx.sh](https://tlsx.sh), [rpx](https://reverse-proxy.sh), [dtsx](https://github.com/stacksjs/dtsx), [localtunnels](https://localtunnel.sh), [bunfig](https://bunfig.netlify.app/), [vite-plugin-local](https://vite-plugin-local.netlify.app/), [ts-collect](https://ts-collect.netlify.app/), [ts-spreadsheets](https://ts-spreadsheets.netlify.app/). + - Small logo placement in the README of >70x `stacksjs/core` repos, `stacksjs/stacks`, `tlsx`, `rpx`, `dtsx`, `localtunnels`, `bunfig`, `vite-plugin-local`, `ts-collect`, `ts-spreadsheets`, and few others. + - Small logo placement in the `BACKERS.md` file of >70x `stacksjs/core` repos, `stacksjs/stacks`, `tlsx`, `rpx`, `dtsx`, `localtunnels`, `bunfig`, `vite-plugin-local`, `ts-collect`, `ts-spreadsheets`, and few others. + +--- + +- **Generous Backer (USD$25/mo):** + - Private Discord channel invite + - Free Personal Account for Stacks Dashboard + - Social media follow + - Name listed in the `BACKERS.md` file of >70x `stacksjs/core` repos, `stacksjs/stacks`, `tlsx`, `rpx`, `dtsx`, `localtunnels`, `bunfig`, `vite-plugin-local`, `ts-collect`, `ts-spreadsheets`, and few others, above other individual backers. + +--- + +- **Sponsorware Tier (USD$10/mo):** + - Get access to all current sponsorware projects. + - Name listed in the `BACKERS.md` file of >70x `stacksjs/core` repos, `stacksjs/stacks`, `tlsx`, `rpx`, `dtsx`, `localtunnels`, `bunfig`, `vite-plugin-local`, `ts-collect`, `ts-spreadsheets`, and few others. + +--- + +- **Individual Backer (USD$5/mo):** + - Name listed in the `BACKERS.md` file of >70x `stacksjs/core` repos, `stacksjs/stacks`, `tlsx`, `rpx`, `dtsx`, `localtunnels`, `bunfig`, `vite-plugin-local`, `ts-collect`, `ts-spreadsheets`, and few others. + +## Current Sponsors + +### Global Special Sponsor + +- Vacant + +### Diamond Sponsors + +- Vacant + +### Platinum Sponsors + +- Vacant + +### Gold Sponsors + +- Vacant + +### Silver Sponsors + +- Vacant + +### Bronze Sponsors + +- Vacant + +### Generous Backers + +- Vacant + +### Individual Backers + +- Vacant + +___ + +##### Thanks to Vue.js for the inspiration for this sponsorship page + +*You can find their sponsorship page [here](https://vuejs.org/sponsor/).*