Skip to content

Commit

Permalink
fix(theme): configure workflow to publish theme on preview url
Browse files Browse the repository at this point in the history
  • Loading branch information
Romakita committed Oct 25, 2024
1 parent 9e76663 commit 92501e3
Show file tree
Hide file tree
Showing 6 changed files with 24 additions and 10 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/website.yml
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ jobs:
run: |
yarn docs:build
touch docs/.vitepress/dist/.nojekyll
echo "beta.tsed.dev" > docs/.vitepress/dist/CNAME
echo "preview.tsed.dev" > docs/.vitepress/dist/CNAME
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
Expand Down
5 changes: 3 additions & 2 deletions docs/.vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ export default defineConfig({
repo: "tsedio/tsed",
githubProxyUrl: "https://api.tsed.io/rest/github/tsedio/tsed",
editLink: {
pattern: "https://github.com/tsedio/tsed-website/edit/main/docs/:path"
pattern: "https://github.com/tsedio/tsed-vitepress-theme/edit/main/docs/:path"
},
search: {
provider: "algolia",
Expand Down Expand Up @@ -162,7 +162,8 @@ export default defineConfig({
link: `/docs/testing`
},
{text: "Upload files", link: "/docs/upload-files"},
{text: "Customize 404", link: "/docs/not-found-page"}
{text: "Customize 404", link: "/docs/not-found-page"},
{text: "Api references", link: "/api"}
]
},
{
Expand Down
13 changes: 13 additions & 0 deletions docs/api.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
meta:
- name: description
content: Api Reference of Ts.ED. Use decorator to build your model and map data.
- name: keywords
content: api reference model decorators ts.ed express typescript node.js javascript jsonschema json mapper serialization deserialization
---

# Api Reference

<br />

[//]: # (<Api />)
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
],
"repository": {
"type": "git",
"url": "https://github.com/tsedio/tsed-website.git"
"url": "https://github.com/tsedio/tsed-vitepress-theme.git"
},
"scripts": {
"build": "monorepo build --verbose",
Expand Down
6 changes: 3 additions & 3 deletions packages/theme/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@
<h1>Ts.ED - VitePress Theme</h1>
<hr />

[![Build & Release](https://github.com/tsedio/tsed/workflows/Build%20&%20Release/badge.svg)](https://github.com/tsedio/tsed-website/actions?query=workflow%3A%22Build+%26+website%22)
[![PR Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/tsedio/tsed-website/blob/master/CONTRIBUTING.md)
[![Build & Release](https://github.com/tsedio/tsed/workflows/Build%20&%20Release/badge.svg)](https://github.com/tsedio/tsed-vitepress-theme/actions?query=workflow%3A%22Build+%26+website%22)
[![PR Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/tsedio/tsed-vitepress-theme/blob/master/CONTRIBUTING.md)
[![npm version](https://badge.fury.io/js/%40tsed%2Fcommon.svg)](https://badge.fury.io/js/%40tsed%2Fvitepress-theme)
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
Expand Down Expand Up @@ -83,7 +83,7 @@ export default config;

## Contributors

Please read [contributing guidelines here](https://github.com/tsedio/tsed-website/CONTRIBUTING.md).
Please read [contributing guidelines here](https://github.com/tsedio/tsed-vitepress-theme/CONTRIBUTING.md).

<a href="https://github.com/tsedio/tsed/graphs/contributors"><img src="https://opencollective.com/tsed/contributors.svg?width=890" /></a>

Expand Down
6 changes: 3 additions & 3 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@
<h1>Ts.ED - New Website</h1>
<hr />

[![Build & Release](https://github.com/tsedio/tsed/workflows/Build%20&%20Release/badge.svg)](https://github.com/tsedio/tsed-website/actions?query=workflow%3A%22Build+%26+website%22)
[![PR Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/tsedio/tsed-website/blob/master/CONTRIBUTING.md)
[![Build & Release](https://github.com/tsedio/tsed/workflows/Build%20&%20Release/badge.svg)](https://github.com/tsedio/tsed-vitepress-theme/actions?query=workflow%3A%22Build+%26+website%22)
[![PR Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/tsedio/tsed-vitepress-theme/blob/master/CONTRIBUTING.md)
[![npm version](https://badge.fury.io/js/%40tsed%2Fcommon.svg)](https://badge.fury.io/js/%40tsed%2Fvitepress-theme)
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
Expand Down Expand Up @@ -63,7 +63,7 @@ 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: https://github.com/tsedio/tsed-website/issues/14
2. Go to this link to pick and assign you a task: https://github.com/tsedio/tsed-vitepress-theme/issues/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](#syntax-migration))
Expand Down

0 comments on commit 92501e3

Please sign in to comment.