Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

nicejade/docz-web-app

Repository files navigation

吾意静晴轩

采用 Docz 构建的 Web 应用程序:https://docz.lovejade.cn/

目标与哲学

吾意静晴轩的诞生,是为了体验采用 Docz 构建 Web 应用程序;同时,为便捷而优雅的创建 Web 应用提供些参考。

Docz,为极简创造文档而生。它有如下特征:

  • 🧘 零配置,无需担心复杂的配置步骤,且使用十分简单;
  • ⚡️ 采用 Wepack 4 构建,完全热重新加载支持和自动代码分割;
  • 📝 基于 MDX( Markdown + JSX ),极大降低组件编写复杂度;
  • 💅易于定制,创建和使用真正的可自定义主题;
  • 🎛 可插拔,使用插件,您可以通过docz流和数据操作很多东西。
  • 🔐 支持 Typescript,允许您的类型定义;

另外,Docz 内置了些许组件,通过在组件构建过程中结合 AST 解析,有可能带来很多出类拔萃的想法,而 Docz 则是更好的选择。甚至,您可以轻松构建和部署您的文档,从而建立您的 Web 应用程序。

如何使用

可将项目 Fork 至自己的代码仓库,运行一下命令即可:

# 🎉 clone the project
git clone https://github.com/${your-github-id}/docz-web-app
cd docz-web-app
# ➕ install dependencies & start dev
yarn && yarn start

修改 deploy.sh 文件中的"自定义域名"以及"仓库路径",运行如下命令,即可实现部署:

# 🚀 deploy to github-page
yarn deploy

需要补充说明的是:项目默认在 master 分支下构建,推送到 gh-pages 分支,发布至 GitHub Pages;在项目 Setings 可启用该服务,如果暂不设定自定义域名,注释该行即可。

相关链接

微信公众号 前端微信群 推荐 Web 应用
😉 静晴轩 ✨ 大前端联盟 🎉 倾城之链
静晴轩 大前端联盟 倾城之链

许可执照

MIT

Copyright (c) 2018-present, nicejade

About

📝 Web applications built with Docz ( 采用 Docz 构建的 Web 应用程序 ).

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

AltStyle によって変換されたページ (->オリジナル) /