Skip to content

Commit 849297b

Browse files
authored
Merge pull request #1 from EDAcation/feat/new-docs
Add new documentation website
2 parents 7ff1830 + bd2c377 commit 849297b

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

49 files changed

+5814
-0
lines changed

.envrc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
use nix

.github/workflows/build.yml

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
name: Build & deploy
2+
3+
on:
4+
workflow_dispatch:
5+
push:
6+
branches:
7+
- "*"
8+
9+
jobs:
10+
build:
11+
name: Build
12+
runs-on: ubuntu-latest
13+
permissions:
14+
pages: write
15+
id-token: write
16+
strategy:
17+
fail-fast: true
18+
outputs:
19+
vsixPath: ${{ steps.packageExtension.outputs.vsixPath }}
20+
steps:
21+
- name: Checkout Source
22+
uses: actions/checkout@v4
23+
- name: Install Node 20
24+
uses: actions/setup-node@v4
25+
with:
26+
node-version: 20
27+
- name: Install Dependencies
28+
run: npm ci
29+
- name: Build website
30+
run: npm run build
31+
- name: Upload static files as artifact
32+
uses: actions/upload-artifact@v4
33+
with:
34+
name: static-files
35+
path: public/
36+
37+
publish:
38+
name: Publish
39+
needs:
40+
- build
41+
if: github.ref_name == 'main'
42+
runs-on: ubuntu-latest
43+
steps:
44+
- name: Checkout Source
45+
uses: actions/checkout@v4
46+
- name: Deploy to Github Pages
47+
uses: actions/deploy-pages@v4
48+
with:
49+
artifact_name: static-files
50+

.gitignore

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
.env
2+
.netlify
3+
.hugo_build.lock
4+
.direnv
5+
node_modules
6+
public
7+
resources

.npmignore

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
.env
2+
.netlify
3+
.hugo_build.lock
4+
.direnv
5+
node_modules
6+
public
7+
resources

.npmrc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
enable-pre-post-scripts=true
2+
auto-install-peers=true
3+
node-linker=hoisted
4+
prefer-symlinked-executables=false

.prettierignore

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
*.html
2+
*.ico
3+
*.png
4+
*.jp*g
5+
*.toml
6+
*.*ignore
7+
*.svg
8+
*.xml
9+
LICENSE
10+
.npmrc
11+
.gitkeep
12+
*.woff*

.prettierrc.yaml

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Default config
2+
tabWidth: 4
3+
endOfLine: crlf
4+
singleQuote: true
5+
printWidth: 100000
6+
trailingComma: none
7+
bracketSameLine: true
8+
quoteProps: consistent
9+
experimentalTernaries: true
10+
11+
# Overrided config
12+
overrides:
13+
- files: ["*.md", "*.json", "*.yaml", "*.yml"]
14+
options:
15+
tabWidth: 2
16+
singleQuote: false
17+
- files: ["*.scss"]
18+
options:
19+
singleQuote: false

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2020-2024 EDAcation
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

assets/cover.png

7.96 KB
Loading

assets/favicon.ico

15 KB
Binary file not shown.

0 commit comments

Comments
 (0)