Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WIP - Documentation website #1

Closed
wants to merge 42 commits into from
Closed
Changes from 1 commit
Commits
Show all changes
42 commits
Select commit Hold shift + click to select a range
5170e44
Test github pages build & deployment
klaasnicolaas Jan 26, 2024
f41b521
Remove template files from scaffold
klaasnicolaas Jan 26, 2024
0059956
Add introduction page
klaasnicolaas Jan 26, 2024
5ef94e4
Add FAQ section
klaasnicolaas Jan 26, 2024
6f9f1c5
Make styling changes and update sidebar
klaasnicolaas Jan 26, 2024
12a316a
Fix build issue with wrong link
klaasnicolaas Jan 26, 2024
b3a4db2
Steps draft on the installation instructions
klaasnicolaas Jan 26, 2024
aa87dd8
Add ESP Web tools button with instructions
klaasnicolaas Jan 27, 2024
708cff8
Test building the firmware and artifact upload
klaasnicolaas Jan 27, 2024
400a4c0
Test again
klaasnicolaas Jan 27, 2024
ab2b124
Test again
klaasnicolaas Jan 27, 2024
59dd67d
Use pattern not name for download artifact
klaasnicolaas Jan 27, 2024
a898965
Test again
klaasnicolaas Jan 27, 2024
632e451
Test again
klaasnicolaas Jan 27, 2024
f18a146
Test again
klaasnicolaas Jan 27, 2024
081dd53
Test again with docs build added
klaasnicolaas Jan 27, 2024
e6afd73
Test with building de static docusaurus website
klaasnicolaas Jan 27, 2024
2ebc8bf
Test again
klaasnicolaas Jan 27, 2024
2a64d59
Test again
klaasnicolaas Jan 27, 2024
dc26e24
Add deployment to github pages
klaasnicolaas Jan 27, 2024
781dbfa
Add note when you forgot the BOOT button
klaasnicolaas Jan 27, 2024
9b9e2c3
Fix 404 error for wrong path to firmware bin
klaasnicolaas Jan 27, 2024
87d3b2e
Update the install instructions
klaasnicolaas Jan 27, 2024
443842d
Update the firmware install instructions
klaasnicolaas Jan 27, 2024
e18dcfe
Write out step 2 and 3 of the installation instruction
klaasnicolaas Jan 27, 2024
f8d86fa
Add instructions for firmware customization
klaasnicolaas Jan 27, 2024
4dae5f2
Small textual changes on the docs
klaasnicolaas Jan 27, 2024
31a26ed
Add last page update date to every docs page
klaasnicolaas Jan 27, 2024
af2dad1
Add local search
klaasnicolaas Jan 27, 2024
e8d1115
Update meta data
klaasnicolaas Jan 27, 2024
a530aa3
Use other color scheme
klaasnicolaas Jan 28, 2024
34a5620
Add icon for Github in navbar
klaasnicolaas Jan 28, 2024
c9d0966
Add configuration for renaming device
klaasnicolaas Jan 28, 2024
3c89ec2
Add github as icon in the navbar
klaasnicolaas Jan 28, 2024
b28d1e4
Debug building matrix and gently stop the CI
klaasnicolaas Jan 28, 2024
2dd120f
Test again
klaasnicolaas Jan 28, 2024
05aeae5
Test again
klaasnicolaas Jan 28, 2024
0619a51
Test again
klaasnicolaas Jan 28, 2024
36bbb78
Test again
klaasnicolaas Jan 28, 2024
78d9224
Update the first time install instructions
klaasnicolaas Jan 28, 2024
417026e
Change instruction for step 6 and 7
klaasnicolaas Feb 5, 2024
e808218
Small textual change
klaasnicolaas Feb 12, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Add icon for Github in navbar
klaasnicolaas committed Jan 28, 2024
commit 34a5620b3391d7b739bff1e025130985578fe486
2 changes: 1 addition & 1 deletion docs/docusaurus.config.ts
Original file line number Diff line number Diff line change
@@ -82,7 +82,7 @@ const config: Config = {
},
{to: '/blog', label: 'Blog', position: 'left'},
{
href: `https://github.com/${organizationName}/${projectName}`,
to: `https://github.com/${organizationName}/${projectName}`,
label: 'GitHub',
position: 'right',
},
2 changes: 2 additions & 0 deletions docs/src/css/custom.css
Original file line number Diff line number Diff line change
@@ -29,6 +29,8 @@
--docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3);
}

@import "navbar.css";

.tabs__item {
align-items: center;
gap: 7px;
41 changes: 41 additions & 0 deletions docs/src/css/navbar.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
.navbar__item.navbar__link[href*="github"] {
position: relative;
padding: 0 1.5rem 0 0;
display: flex;
font-size: 0;
}

.navbar__item.navbar__link[href*="github"]:before {
content: "";
width: 1.5rem;
height: 1.5rem;
background-image: url("/img/brand-github.svg");
background-repeat: no-repeat;
}

html[data-theme="dark"] .navbar__item.navbar__link[href*="github"]:before {
background-image: url("/img/brand-github-inverted.svg");
}

@media screen and (max-width: 966px) {
.navbar__item.navbar__link[href*="github"] {
display: none;
}
}

.github-counter {
position: absolute;
color: #000;
top: -10px;
right: 4px;
font-size: 9px;
background-color: #ccc;
padding: 2px 5px;
border-radius: 10px;
z-index: -1;
}

html[data-theme="dark"] .github-counter {
background-color: #222;
color: #fff;
}
20 changes: 20 additions & 0 deletions docs/src/pages/index.tsx
Original file line number Diff line number Diff line change
@@ -6,6 +6,11 @@ import HomepageFeatures from '@site/src/components/HomepageFeatures';
import Heading from '@theme/Heading';

import styles from './index.module.css';
// import { useEffect } from 'react';

// const kFormatter = (num) => {
// return Math.sign(num) * (Math.abs(num) / 1000).toFixed(1) + "k"
// }

function HomepageHeader() {
const {siteConfig} = useDocusaurusContext();
@@ -29,6 +34,21 @@ function HomepageHeader() {
}

export default function Home(): JSX.Element {
// useEffect(() => {
// window
// .fetch("https://api.github.com/repos/tetele/onju-voice-satellite")
// .then((res) => res.json())
// .then((data) => {
// const githubLink = document.querySelector(
// ".navbar__item.navbar__link[href*='github']"
// )
// const githubStat = document.createElement("span")
// githubStat.innerHTML = data.stargazers_count
// githubStat.className = "github-counter"
// githubLink.appendChild(githubStat)
// })
// }, [])

return (
<Layout
title={`Home`}
4 changes: 4 additions & 0 deletions docs/static/img/brand-github-inverted.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 4 additions & 0 deletions docs/static/img/brand-github.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.