Skip to content

Latest commit

 

History

History
131 lines (86 loc) · 5.59 KB

readme.md

File metadata and controls

131 lines (86 loc) · 5.59 KB
Raw

Ts.ED logo

Ts.ED - New Website

Build & Release PR Welcome npm version semantic-release code style: prettier github opencollective

Website   •   Getting started   •   Slack   •   Twitter

A Node.js and TypeScript Framework on top of Express. It provides a lot of decorators and guidelines to write your code.

What it is

This repository is the new website for Ts.ED. It replaces the old website https://tsed.io based on VuePress 1.x by a new website based on VitePress.

Installation

yarn install

Development

yarn docs:dev
yarn storybook

Build

yarn docs:build

Note: The build check the dead links in the documentation.

Migration guideline

Most of the VuePress feature are available in VitePress. However, VuePress use Vue 2 and VitePress use Vue 3. So right now, we migrate the content without all custom components.

How to migrate a content (PR)

  1. Ask me to be added to the migration team (it gives you access to this repo)
  2. Go to this link to pick and assign you a task: #14
  3. Start PR
  4. Get the legacy content from https://github.com/tsedio/tsed/tree/production/docs
  5. Review the content and migrate syntax that must me converted (see syntax migration)
  6. Submit PR

Migrate page per page is really fast and you should take very little time but will enormously advance migration. So thank you for your help!!

Syntax migration

Tabs

In VuePress, we use a custom Tabs component to display content in tabs:

<Tabs class="-code">
  <Tab label="Jest"> <<< @/docs/snippets/testing/parse-service.jest.spec.ts </Tab>
  <Tab label="Vitest"> <<< @/docs/snippets/testing/parse-service.vitest.spec.ts </Tab>
  <Tab label="Mocha"> <<< @/docs/snippets/testing/parse-service.mocha.spec.ts </Tab>
  <Tab label="ParseService.ts"> <<< @/docs/snippets/testing/parse-service.ts </Tab>
</Tabs>

VitePress has a custom markdown syntax for tabs. Base on the previous example, we can rewrite the previous example like this:

::: code-group

<<< @/docs/snippets/testing/parse-service.jest.spec.ts [jest]

<<< @/docs/snippets/testing/parse-service.vitest.spec.ts [vitest]

<<< @/docs/snippets/testing/parse-service.mocha.spec.ts [mocha]

<<< @/docs/snippets/testing/parse-service.ts [ParseService.ts]

:::

Contributors

Please read contributing guidelines here.

Backers

Thank you to all our backers! 🙏 [Become a backer]

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]

License

The MIT License (MIT)

Copyright (c) 2016 - 2023 Romain Lenzotti

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.