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

Test an alternative to sphinx #1977

Closed
wants to merge 3 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,6 @@ docs/EN/_build/
docs/CROWDIN/fr/_build/
docs/CROWDIN/de/_build/
docs/CROWDIN/nl/_build/
node_modules/
.vitepress/cache/
.vitepress/dist/
133 changes: 133 additions & 0 deletions .vitepress/config/en.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,133 @@
import { defineConfig } from "vitepress";

export const en = defineConfig({
lang: "en-US",
description: "Opensource automated insulin delivery system (closed loop)",

themeConfig: {
// https://vitepress.dev/reference/default-theme-config
nav: [
{ text: "Home", link: "/" },
{ text: "Getting started", link: "/Getting-Started" },
{ text: "FAQ", link: "/Getting-Started" },
{
text: "Resources",
items: [
{
text: "X (formerly Twitter)",
link: "/",
},
{
text: "Discord Chat",
link: "/",
},
{
text: "Releases ",
link: "/",
},
],
},
],

sidebar: [
{
text: "Getting Started",
collapsed: false,
items: [
{
text: "Introduction", // What is AndroidAPS and what can it do?
link: "/introduction",
},
{
text: "Preparing", // What do I need to get started?
link: "",
},
{
text: "Components setup",
collapsed: true,
items: [
{
text: "CGM / FGM",
link: "",
},
{
text: "xDrip Settings",
link: "",
},
{
text: "Pump",
link: "",
},
{
text: "Phone",
link: "",
},
{
text: "Smartwatch",
link: "",
},
],
},
{
text: "Building AAPS",
link: "",
},
{
text: "Initial setup",
link: "",
},
{
text: "Towards closed loop", // completing the objectives
link: "",
},
],
},
{
text: "AAPS Usage",
collapsed: true,
items: [],
},
{
text: "Advanced Topics",
collapsed: true,
items: [],
},
{
text: "Troubleshooting",
collapsed: true,
items: [],
},
{
text: "FAQ",
collapsed: true,
items: [],
},
{
text: "Community",
collapsed: true,
items: [
{
text: "Where to find help",
items: [],
},
{
text: "Contributing",
collapsed: true,
items: [],
},
],
},
],

editLink: {
pattern:
"https://github.com/openaps/AndroidAPSdocs/edit/master/docs/EN/:path",
text: "Edit this page",
},

footer: {
message: "Released under the AGPL-3.0 License.",
copyright: "© Copyright AndroidAPS community",
},
},
});
87 changes: 87 additions & 0 deletions .vitepress/config/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
import { defineConfig } from "vitepress";
import { en } from "./en";

// https://vitepress.dev/reference/site-config
export default defineConfig({
title: "AndroidAPS",

// TODO
srcDir: "test",
ignoreDeadLinks: true,

lastUpdated: true,
cleanUrls: true,
metaChunk: true,
sitemap: {
hostname: "https://wiki.aaps.app",
},

head: [
// [
// "link",
// { rel: "icon", type: "image/svg+xml", href: "/androidaps-logo.svg" },
// ],
["link", { rel: "icon", type: "image/png", href: "/androidaps-logo.png" }],
["meta", { name: "theme-color", content: "#5f67ee" }],
["meta", { property: "og:type", content: "website" }],
["meta", { property: "og:locale", content: "en" }],
[
"meta",
{
property: "og:title",
content:
"AndroidAPS | Opensource automated insulin delivery system (closed loop)",
},
],
["meta", { property: "og:site_name", content: "AndroidAPS" }],
// [
// "meta",
// {
// property: "og:image",
// content: "https://wiki.aaps.app/androidaps-og.jpg",
// },
// ],
["meta", { property: "og:url", content: "https://wiki.aaps.app/" }],
],

themeConfig: {
logo: { src: "/androidaps-logo.png", width: 24, height: 24 },

socialLinks: [
{ icon: "github", link: "https://github.com/nightscout/AndroidAPS" },
],

search: {
provider: "local",
},
},

markdown: {
theme: {
light: "github-light",
dark: "github-dark",
},
},

locales: {
root: { label: "English", ...en },
de: {
label: "Deutsch",
lang: "de",
// link: "/de/",
},
zh: {
label: "简体中文",
lang: "zh",
// link: "/zh/",
},
},

vite: {
server: {
watch: {
ignored: ["**/node_modules/**", "**/.git/**", "**/images/**"],
},
},
},
});
Binary file added bun.lockb
Binary file not shown.
18 changes: 18 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
{
"dependencies": {},
"devDependencies": {
"vitepress": "^1.0.0-rc.44",
"@types/bun": "latest"
},
"name": "androidapsdocs",
"module": "index.ts",
"type": "module",
"peerDependencies": {
"typescript": "^5.0.0"
},
"scripts": {
"dev": "vitepress dev",
"build": "vitepress build",
"preview": "vitepress preview"
}
}
Binary file added test/images/basic-outline-of-AAPS.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
48 changes: 48 additions & 0 deletions test/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
layout: home

title: AndroidAPS
titleTemplate: Opensource automated insulin delivery system (closed loop)

hero:
name: AndroidAPS
text: Opensource automated insulin delivery system (closed loop)
tagline:
actions:
- theme: brand
text: Get Started
link: /introduction
image:
src: /androidaps-logo.png
alt: AndroidAPS

features:
- icon: 🔌
title: Configurable
details: Use AAPS with one of the many supported CGM/FGMs, Pumps and your Android phone
- icon: 📖
title: Open-Source
details: Help improving AAPS, enjoy flexibility and be sure no-one will steal your data
---

<style>
:root {
--vp-home-hero-name-color: transparent;
--vp-home-hero-name-background: -webkit-linear-gradient(120deg, #bd34fe 30%, #41d1ff);

--vp-home-hero-image-background-image: linear-gradient(-45deg, #bd34fe 50%, #47caff 50%);
--vp-home-hero-image-filter: blur(44px);
}

@media (min-width: 640px) {
:root {
--vp-home-hero-image-filter: blur(56px);
}
}

@media (min-width: 960px) {
:root {
--vp-home-hero-image-filter: blur(68px);
}
}
</style>
Loading