Skip to content

Commit a3f1d86

Browse files
authored
Merge pull request #1 from njzjz/main
add a vuepress website
2 parents 96c8125 + 72d0ac7 commit a3f1d86

File tree

7 files changed

+3860
-0
lines changed

7 files changed

+3860
-0
lines changed

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
node_modules
2+
.temp
3+
.cache

docs/.github/workflows/push.yaml

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
on:
2+
push:
3+
branches:
4+
- main
5+
pull_request:
6+
name: Build and deploy on push
7+
jobs:
8+
build:
9+
name: yarn install
10+
runs-on: ubuntu-latest
11+
steps:
12+
- uses: actions/checkout@master
13+
- uses: actions/setup-node@v2
14+
with:
15+
node-version: 14
16+
- name: Get yarn cache
17+
id: yarn-cache
18+
run: echo "::set-output name=dir::$(yarn cache dir)"
19+
- uses: actions/cache@v2
20+
with:
21+
path: ${{ steps.yarn-cache.outputs.dir }}
22+
key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
23+
restore-keys: |
24+
${{ runner.os }}-yarn-
25+
- run: yarn install
26+
- run: yarn docs:build
27+
- name: Deploy to GitHub Pages
28+
uses: JamesIves/github-pages-deploy-action@releases/v3
29+
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
30+
with:
31+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
32+
BRANCH: gh-pages
33+
FOLDER: docs/.vuepress/dist
34+
BASE_BRANCH: main
35+
CLEAN: true

docs/.vuepress/config.js

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
// .vuepress/config.js
2+
3+
const icon = "https://avatars.githubusercontent.com/u/32671488?s=200&v=4";
4+
module.exports = {
5+
locales: {
6+
'/': {
7+
lang: 'en-US',
8+
title: 'DeepModeling',
9+
description: ''
10+
},
11+
},
12+
head: [
13+
['link', { rel: 'icon', href: icon }],
14+
['meta', { name: 'apple-mobile-web-app-capable', content: 'yes' }],
15+
['link', { rel: 'apple-touch-icon', href: icon }],
16+
['meta', { name: 'msapplication-TileImage', content: icon }]
17+
],
18+
themeConfig: {
19+
editLinks: true,
20+
logo: icon,
21+
locales: {
22+
'/': {
23+
selectText: 'Languages',
24+
label: 'English',
25+
editLinkText: 'Edit this page on GitHub',
26+
navbar: [
27+
{ text: 'Home', link: '/' },
28+
{ text: 'Blog', link: '/blog/', target: '_blank' },
29+
]
30+
},
31+
}
32+
},
33+
}
File renamed without changes.

docs/README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
home: true
3+
heroImage: https://avatars.githubusercontent.com/u/32671488?s=200&v=4
4+
heroText: DeepModeling
5+
tagline:
6+
actions:
7+
- text: Contribute to community
8+
link: https://github.com/deepmodeling
9+
type: primary
10+
features:
11+
- title: Machine Learning
12+
details: An effective tool for analyzing complex data
13+
- title: Physical Modeling
14+
details: A scientific description of the physical world
15+
- title: Computational Platforms
16+
details: A cutting-edge bridge between machine learning and physical modeling
17+
footer: Copyright © 2021 DeepModeling
18+
---

package.json

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"devDependencies": {
3+
"vuepress": "^2.0.0-beta.18"
4+
},
5+
"scripts": {
6+
"docs:dev": "vuepress dev docs",
7+
"docs:build": "vuepress build docs"
8+
}
9+
}

0 commit comments

Comments
 (0)