archive-gh-me/yew
1
0
Fork 0
mirror of https://github.com/yewstack/yew.git synced 2025-12-08 21:26:25 +00:00
Code Issues Projects Releases Wiki Activity
yew/website
History
Matt 90b4e55ebc
Docusaurus Overhaul (#2275) 
* change suffixes from md to mdx
fix broken links for English locale
tree shake and update docusaurus
add docusaurus ideal image plugin
use svg and themed image
delete unused static asset

* move localized landing page

* change GitLocalize project page

* nit pick

* remove ignore to have the block checked
2021-12-20 12:10:45 +02:00
..
docs
Docusaurus Overhaul (#2275)
2021-12-20 12:10:45 +02:00
i18n
Docusaurus Overhaul (#2275)
2021-12-20 12:10:45 +02:00
src
Update index.mdx (#2226)
2021-12-01 22:03:51 +05:00
static
Docusaurus Overhaul (#2275)
2021-12-20 12:10:45 +02:00
versioned_docs
Docusaurus Overhaul (#2275)
2021-12-20 12:10:45 +02:00
versioned_sidebars
Final documentation touch ups & tag 0.19.0 (#2220)
2021-11-30 00:06:51 +05:00
.gitignore
Docusaurus v2 (#1872)
2021-05-26 22:32:07 +02:00
babel.config.js
Docusaurus v2 (#1872)
2021-05-26 22:32:07 +02:00
docusaurus.config.js
Docusaurus Overhaul (#2275)
2021-12-20 12:10:45 +02:00
package-lock.json
Docusaurus Overhaul (#2275)
2021-12-20 12:10:45 +02:00
package.json
Docusaurus Overhaul (#2275)
2021-12-20 12:10:45 +02:00
README.md
Docusaurus Overhaul (#2275)
2021-12-20 12:10:45 +02:00
sidebars.js
Final documentation touch ups & tag 0.19.0 (#2220)
2021-11-30 00:06:51 +05:00
tsconfig.json
Docusaurus v2 (#1872)
2021-05-26 22:32:07 +02:00
versions.json
Final documentation touch ups & tag 0.19.0 (#2220)
2021-11-30 00:06:51 +05:00

README.md

Website

This website is built using Docusaurus 2, a modern static website generator.

Installation

npm install

Local Development

npm start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. Note this only builds for English locale unlike a production build.

Documentation is written in mdx, markdown empowered with jsx. JetBrains and VSCode both provide MDX plugins.

Production Build

npm run build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.