Skip to content

Commit

Permalink
chore: rebuild lumos API docs when building website (#371)
Browse files Browse the repository at this point in the history
* chore: rebuild lumos API docs when building website

* chore: rebuild lumos API docs when building website
  • Loading branch information
homura authored Jul 21, 2022
1 parent e65561c commit d91a96f
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 5 deletions.
4 changes: 2 additions & 2 deletions typedoc.js
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
module.exports = {
mode: "modules",
out: "docusaurus/website/static/api",
out: "website/static/api",
exclude: [
"**/node_modules/**",
"**/tests/**/*",
"**/examples/**/*",
"**/docusaurus/**/*",
"**/website/**/*",
"**/examples/**/*",
],
name: "lumos",
Expand Down
3 changes: 3 additions & 0 deletions website/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,6 @@
npm-debug.log*
yarn-debug.log*
yarn-error.log*

# typedoc generated
static/api
6 changes: 4 additions & 2 deletions website/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,8 @@ const config = {
routeBasePath: "/",
// Please change this to your repo.
// Remove this to remove the "edit this page" links.
editUrl: "https://github.com/nervosnetwork/lumos/tree/develop/website",
editUrl:
"https://github.com/nervosnetwork/lumos/tree/develop/website",
},
theme: {
customCss: require.resolve("./src/css/custom.css"),
Expand Down Expand Up @@ -81,9 +82,10 @@ const config = {
},
// { to: "/blog", label: "Blog", position: "left" },
{
href: "https://lumos-website.vercel.app/api/index.html",
href: "/api/",
label: "API",
position: "left",
target: "_blank",
},
{
href: "https://github.com/nervosnetwork/lumos",
Expand Down
2 changes: 1 addition & 1 deletion website/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"scripts": {
"docusaurus": "docusaurus",
"start": "docusaurus start",
"build-lumos": "cd .. && yarn install && yarn run build && yarn run build-release",
"build-lumos": "cd .. && yarn install && yarn run build && yarn run build-release && yarn run docs",
"build": "docusaurus build",
"swizzle": "docusaurus swizzle",
"deploy": "docusaurus deploy",
Expand Down

1 comment on commit d91a96f

@vercel
Copy link

@vercel vercel bot commented on d91a96f Jul 21, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

lumos-website – ./

lumos-website-git-develop-cryptape.vercel.app
lumos-website.vercel.app
lumos-website-cryptape.vercel.app

Please sign in to comment.