Skip to content

Commit 69fe22e

Browse files
a-gavea-gave
committed
Initial commit
0 parents  commit 69fe22e

52 files changed

Lines changed: 2671 additions & 0 deletions

Some content is hidden

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

‎.github/workflows/deploy.yml‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
# Sample workflow for building and deploying a VitePress site to GitHub Pages
2+
#
3+
name: Deploy VitePress site to Pages
4+
5+
on:
6+
# Runs on pushes targeting the `main` branch. Change this to `master` if you're
7+
# using the `master` branch as the default branch.
8+
push:
9+
branches: [main]
10+
11+
# Allows you to run this workflow manually from the Actions tab
12+
workflow_dispatch:
13+
14+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
15+
permissions:
16+
contents: read
17+
pages: write
18+
id-token: write
19+
20+
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
21+
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
22+
concurrency:
23+
group: pages
24+
cancel-in-progress: false
25+
26+
jobs:
27+
# Build job
28+
build:
29+
runs-on: ubuntu-latest
30+
steps:
31+
- name: Checkout
32+
uses: actions/checkout@v5
33+
with:
34+
fetch-depth: 0 # Not needed if lastUpdated is not enabled
35+
- uses: pnpm/action-setup@v4 # Uncomment this block if you're using pnpm
36+
with:
37+
version: 9 # Not needed if you've set "packageManager" in package.json
38+
# - uses: oven-sh/setup-bun@v1 # Uncomment this if you're using Bun
39+
- name: Setup Node
40+
uses: actions/setup-node@v6
41+
with:
42+
node-version: 24
43+
cache: pnpm # or pnpm / yarn
44+
- name: Setup Pages
45+
uses: actions/configure-pages@v4
46+
- name: Install dependencies
47+
run: pnpm install # or pnpm install / yarn install / bun install
48+
- name: Build with VitePress
49+
run: pnpm run docs:build # or pnpm docs:build / yarn docs:build / bun run docs:build
50+
- name: Upload artifact
51+
uses: actions/upload-pages-artifact@v3
52+
with:
53+
path: docs/.vitepress/dist
54+
55+
# Deployment job
56+
deploy:
57+
environment:
58+
name: github-pages
59+
url: ${{ steps.deployment.outputs.page_url }}
60+
needs: build
61+
runs-on: ubuntu-latest
62+
name: Deploy
63+
steps:
64+
- name: Deploy to GitHub Pages
65+
id: deployment
66+
uses: actions/deploy-pages@v4

‎.gitignore‎

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

‎docs/.vitepress/config.mts‎

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
import { defineConfig } from 'vitepress'
2+
3+
const pkg = {
4+
version: 2024.1,
5+
version_compatible: ['23.05'],
6+
branch: 'master',
7+
branch_compatible: ['main', '25.12', '24.10']
8+
}
9+
10+
// https://vitepress.dev/reference/site-config
11+
export default defineConfig({
12+
title: "LibreMesh",
13+
description: "A modular framework for creating OpenWrt-based firmwares for wireless mesh nodes",
14+
head: [['link', { rel: 'icon', href: '/favicon.ico' }]],
15+
lastUpdated: true,
16+
17+
base: '/libremesh.github.io',
18+
19+
themeConfig: {
20+
// https://vitepress.dev/reference/default-theme-config
21+
logo: { light: 'libremesh_logo.svg', dark: 'libremesh_logo.svg', alt: 'Logo' },
22+
siteTitle: false,
23+
search: {
24+
provider: 'local'
25+
},
26+
27+
nav: [
28+
{ text: 'CHANGELOG', link: '/changelog' },
29+
// { text: 'Source', link: 'https://github.com/libremesh/lime-packages'},
30+
{ text: 'Issues', link: 'https://github.com/libremesh/lime-packages/issues'},
31+
],
32+
33+
sidebar: [
34+
{
35+
text: 'Introduction',
36+
items: [
37+
{ text: 'What is LibreMesh', link: '/about' },
38+
{ text: 'How it works', link: '/how-it-works' },
39+
]
40+
},
41+
{
42+
text: 'Getting Started',
43+
items: [
44+
{ text: 'Install', link: '/install' },
45+
{ text: 'Download the firmware', link: '/download' },
46+
{ text: 'Build it from sources',
47+
link: '/build',
48+
items: [
49+
{ text: 'Imagebuilder',
50+
link: '/build/imagebuilder',
51+
items: [
52+
{ text: 'Docker', link: '/build/imagebuilder/docker'},
53+
{ text: 'Debian', link: '/build/imagebuilder/debian'}
54+
]
55+
},
56+
{ text: 'Buildroot', link: '/build/buildroot/debian'}
57+
]}
58+
]
59+
},
60+
{
61+
text: 'Configuration',
62+
items: [
63+
{ text: 'GUI configuration', link: '/gui-configuration' },
64+
{ text: 'CLI configuration', link: '/cli-configuration' },
65+
{ text: 'Supported flavors', link: '/api-examples' },
66+
{ text: 'Network Profiles', link: '/network-profiles' }
67+
]
68+
},
69+
{
70+
text: 'Communication',
71+
items: [
72+
{ text: 'Meetings', link: '/meetings' }
73+
74+
]
75+
},
76+
],
77+
78+
socialLinks: [
79+
{ icon: 'github', link: 'https://github.com/libremesh/lime-packages' },
80+
{ icon: 'maildotru', link: 'https://www.autistici.org/mailman/listinfo/libremesh' },
81+
{ icon: 'matrix', link: 'https://matrix.to/#/#libremesh-dev:matrix.guifi.net' },
82+
{ icon: 'peertube', link: 'https://media.exo.cat/a/libremesh' },
83+
{ icon: 'mastodon', link: 'https://social.freifunk.net/@libremesh' }
84+
],
85+
}
86+
})

‎docs/.vitepress/theme/index.ts‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
// https://vitepress.dev/guide/custom-theme
2+
import { h } from 'vue'
3+
import type { Theme } from 'vitepress'
4+
import DefaultTheme from 'vitepress/theme'
5+
import './style.css'
6+
7+
export default {
8+
extends: DefaultTheme,
9+
Layout: () => {
10+
return h(DefaultTheme.Layout, null, {
11+
// https://vitepress.dev/guide/extending-default-theme#layout-slots
12+
})
13+
},
14+
enhanceApp({ app, router, siteData }) {
15+
// ...
16+
}
17+
} satisfies Theme

‎docs/.vitepress/theme/style.css‎

Lines changed: 135 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,135 @@
1+
/**
2+
* Customize default theme styling by overriding CSS variables:
3+
* https://github.com/vuejs/vitepress/blob/main/src/client/theme-default/styles/vars.css
4+
*/
5+
6+
/**
7+
* Colors
8+
*
9+
* Each colors have exact same color scale system with 3 levels of solid
10+
* colors with different brightness, and 1 soft color.
11+
*
12+
* - `XXX-1`: The most solid color used mainly for colored text. It must
13+
* satisfy the contrast ratio against when used on top of `XXX-soft`.
14+
*
15+
* - `XXX-2`: The color used mainly for hover state of the button.
16+
*
17+
* - `XXX-3`: The color for solid background, such as bg color of the button.
18+
* It must satisfy the contrast ratio with pure white (#ffffff) text on
19+
* top of it.
20+
*
21+
* - `XXX-soft`: The color used for subtle background such as custom container
22+
* or badges. It must satisfy the contrast ratio when putting `XXX-1` colors
23+
* on top of it.
24+
*
25+
* The soft color must be semi transparent alpha channel. This is crucial
26+
* because it allows adding multiple "soft" colors on top of each other
27+
* to create an accent, such as when having inline code block inside
28+
* custom containers.
29+
*
30+
* - `default`: The color used purely for subtle indication without any
31+
* special meanings attached to it such as bg color for menu hover state.
32+
*
33+
* - `brand`: Used for primary brand colors, such as link text, button with
34+
* brand theme, etc.
35+
*
36+
* - `tip`: Used to indicate useful information. The default theme uses the
37+
* brand color for this by default.
38+
*
39+
* - `warning`: Used to indicate warning to the users. Used in custom
40+
* container, badges, etc.
41+
*
42+
* - `danger`: Used to show error, or dangerous message to the users. Used
43+
* in custom container, badges, etc.
44+
* -------------------------------------------------------------------------- */
45+
46+
:root {
47+
--vp-c-default-1: var(--vp-c-gray-1);
48+
--vp-c-default-2: var(--vp-c-gray-2);
49+
--vp-c-default-3: var(--vp-c-gray-3);
50+
--vp-c-default-soft: var(--vp-c-gray-soft);
51+
52+
--vp-c-brand-1: var(--vp-c-indigo-1);
53+
--vp-c-brand-2: var(--vp-c-indigo-2);
54+
--vp-c-brand-3: var(--vp-c-indigo-3);
55+
--vp-c-brand-soft: var(--vp-c-indigo-soft);
56+
57+
--vp-c-tip-1: var(--vp-c-brand-1);
58+
--vp-c-tip-2: var(--vp-c-brand-2);
59+
--vp-c-tip-3: var(--vp-c-brand-3);
60+
--vp-c-tip-soft: var(--vp-c-brand-soft);
61+
62+
--vp-c-warning-1: var(--vp-c-yellow-1);
63+
--vp-c-warning-2: var(--vp-c-yellow-2);
64+
--vp-c-warning-3: var(--vp-c-yellow-3);
65+
--vp-c-warning-soft: var(--vp-c-yellow-soft);
66+
67+
--vp-c-danger-1: var(--vp-c-red-1);
68+
--vp-c-danger-2: var(--vp-c-red-2);
69+
--vp-c-danger-3: var(--vp-c-red-3);
70+
--vp-c-danger-soft: var(--vp-c-red-soft);
71+
}
72+
73+
/**
74+
* Component: Button
75+
* -------------------------------------------------------------------------- */
76+
77+
:root {
78+
--vp-button-brand-border: transparent;
79+
--vp-button-brand-text: var(--vp-c-white);
80+
--vp-button-brand-bg: var(--vp-c-brand-3);
81+
--vp-button-brand-hover-border: transparent;
82+
--vp-button-brand-hover-text: var(--vp-c-white);
83+
--vp-button-brand-hover-bg: var(--vp-c-brand-2);
84+
--vp-button-brand-active-border: transparent;
85+
--vp-button-brand-active-text: var(--vp-c-white);
86+
--vp-button-brand-active-bg: var(--vp-c-brand-1);
87+
}
88+
89+
/**
90+
* Component: Home
91+
* -------------------------------------------------------------------------- */
92+
93+
:root {
94+
--vp-home-hero-name-color: transparent;
95+
--vp-home-hero-name-background: -webkit-linear-gradient(
96+
120deg,
97+
#bd34fe 30%,
98+
#41d1ff
99+
);
100+
101+
--vp-home-hero-image-background-image: linear-gradient(
102+
-45deg,
103+
#bd34fe 50%,
104+
#47caff 50%
105+
);
106+
--vp-home-hero-image-filter: blur(44px);
107+
}
108+
109+
@media (min-width: 640px) {
110+
:root {
111+
--vp-home-hero-image-filter: blur(56px);
112+
}
113+
}
114+
115+
@media (min-width: 960px) {
116+
:root {
117+
--vp-home-hero-image-filter: blur(68px);
118+
}
119+
}
120+
121+
/**
122+
* Component: Custom Block
123+
* -------------------------------------------------------------------------- */
124+
125+
:root {
126+
--vp-custom-block-tip-border: transparent;
127+
--vp-custom-block-tip-text: var(--vp-c-text-1);
128+
--vp-custom-block-tip-bg: var(--vp-c-brand-soft);
129+
--vp-custom-block-tip-code-bg: var(--vp-c-brand-soft);
130+
}
131+
132+
:root {
133+
--vp-home-hero-name-color: #008300;
134+
}
135+

‎docs/about.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
![Libremesh](/libremesh_logo.svg)
2+
3+
LibreMesh is a community and an open project, so anyone friendly is welcome.
4+
We encourage anyone using the LibreMesh to become part of this community.
5+
The software is maintained by some of its founders together with a link [wide_community](https://github.com/libremesh/lime-packages/graphs/contributors).
6+
7+
## LibreMesh founders
8+
| | |
9+
| ------------------- | ----------------------- |
10+
| Gioacchino Mazzurco | gio[at]eigenlab[dot]org |
11+
| Gui | - |
12+
| Nico | - |
13+
| Pau | p4u[at]dabax[dot]net |
14+
15+
16+
## Contributors to LibreMesh development
17+
Here a [detailed list](https://www.openhub.net/p/libre-mesh/contributors?sort=commits)
18+
19+
!["List of contributors to LibreMesh development"](https://opencollective.com/libremesh/contributors.svg?width=700&button=false)
20+
21+
## Donations
22+
23+
Donations to the project are managed via OpenCollective, thanks!
24+
[![Contributions via OpenCollective](/opencollective.png)](https://opencollective.com/libremesh/contribute)

‎docs/api-examples.md‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
---
2+
outline: deep
3+
---
4+
5+
# Runtime API Examples
6+
7+
This page demonstrates usage of some of the runtime APIs provided by VitePress.
8+
9+
The main `useData()` API can be used to access site, theme, and page data for the current page. It works in both `.md` and `.vue` files:
10+
11+
```md
12+
<script setup>
13+
import { useData } from 'vitepress'
14+
15+
const { theme, page, frontmatter } = useData()
16+
</script>
17+
18+
## Results
19+
20+
### Theme Data
21+
<pre>{{ theme }}</pre>
22+
23+
### Page Data
24+
<pre>{{ page }}</pre>
25+
26+
### Page Frontmatter
27+
<pre>{{ frontmatter }}</pre>
28+
```
29+
30+
<script setup>
31+
import { useData } from 'vitepress'
32+
33+
const { site, theme, page, frontmatter } = useData()
34+
</script>
35+
36+
## Results
37+
{{ site }}
38+
39+
### Theme Data
40+
<pre>{{ theme }}</pre>
41+
42+
### Page Data
43+
<pre>{{ page }}</pre>
44+
45+
### Page Frontmatter
46+
<pre>{{ frontmatter }}</pre>
47+
48+
## More
49+
50+
Check out the documentation for the [full list of runtime APIs](https://vitepress.dev/reference/runtime-api#usedata).

0 commit comments

Comments
 (0)