From e8597e44d2cb0c3a2daf1dca34ba589554b64f51 Mon Sep 17 00:00:00 2001 From: lmtr0 Date: Tue, 30 Aug 2022 17:56:47 -0300 Subject: [PATCH 01/16] new: 404 page --- src/components/404.svelte | 17 +++++ src/layouts/SimpleLayout.astro | 129 +++++++++++++++++++++++++++++++++ src/pages/404.astro | 8 ++ 3 files changed, 154 insertions(+) create mode 100644 src/components/404.svelte create mode 100644 src/layouts/SimpleLayout.astro create mode 100644 src/pages/404.astro diff --git a/src/components/404.svelte b/src/components/404.svelte new file mode 100644 index 0000000..ada713c --- /dev/null +++ b/src/components/404.svelte @@ -0,0 +1,17 @@ + + +

404

+

Not Found

+ +
+ + + +
diff --git a/src/layouts/SimpleLayout.astro b/src/layouts/SimpleLayout.astro new file mode 100644 index 0000000..1048796 --- /dev/null +++ b/src/layouts/SimpleLayout.astro @@ -0,0 +1,129 @@ +--- +import HeadCommon from '../components/HeadCommon.astro'; +import HeadSEO from '../components/HeadSEO.astro'; +import Header from '../components/Header/Header.astro'; +import PageContent from '../components/PageContent/PageContent.astro'; +import LeftSidebar from '../components/LeftSidebar/LeftSidebar.astro'; +import RightSidebar from '../components/RightSidebar/RightSidebar.astro'; +import * as config from '../config'; + +const { frontmatter = {}, headings } = Astro.props; +const canonicalURL = new URL(Astro.url.pathname, Astro.site); +let currentPage = Astro.url.pathname; +if (currentPage.endsWith("/")) { + currentPage = currentPage.slice(0, currentPage.length - 1) +} +const currentFile = config.Files[currentPage]; + +const githubEditUrl = config.EditUrl + currentFile; +--- + + + + + + + + + + + + + {frontmatter.title ? `${frontmatter.title} - ${config.Site.title}` : config.Site.title} + + + + + +
+
+ +
+ +
+
+ + diff --git a/src/pages/404.astro b/src/pages/404.astro new file mode 100644 index 0000000..fdf0112 --- /dev/null +++ b/src/pages/404.astro @@ -0,0 +1,8 @@ +--- +import Layout from "~/layouts/SimpleLayout.astro" +import P404 from "~/components/404.svelte" +--- + + + + \ No newline at end of file -- GitLab From 051fb239fd925ad6d0b69f55255b667db0d9dc11 Mon Sep 17 00:00:00 2001 From: lmtr0 Date: Wed, 31 Aug 2022 07:44:56 -0300 Subject: [PATCH 02/16] fix: corrected site --- astro.config.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/astro.config.ts b/astro.config.ts index f176022..d24ddb6 100644 --- a/astro.config.ts +++ b/astro.config.ts @@ -23,7 +23,7 @@ const config: AstroUserConfig = { }), astroAsides(), ], - site: `http://astro.build`, + site: `http://docs.higenku.org`, vite: { plugins: [vitePreact()], }, -- GitLab From 59479f0f8489de645225281aec713703ab94426b Mon Sep 17 00:00:00 2001 From: lmtr0 Date: Thu, 1 Sep 2022 16:51:46 -0300 Subject: [PATCH 03/16] wip: working on markdown extensions --- integration/remark.ts | 26 ++++++++++++++------ src/components/{Aside.astro => Alert.astro} | 0 src/components/PageContent/PageContent.astro | 2 +- src/layouts/MainLayout.astro | 3 ++- src/pages/en/index.md | 16 +++++++++++- 5 files changed, 37 insertions(+), 10 deletions(-) rename src/components/{Aside.astro => Alert.astro} (100%) diff --git a/integration/remark.ts b/integration/remark.ts index 379f3f6..cebdc36 100644 --- a/integration/remark.ts +++ b/integration/remark.ts @@ -6,7 +6,7 @@ import remarkDirective from "remark-directive"; import { visit } from "unist-util-visit"; import { remove } from "unist-util-remove"; -const AsideTagname = "Aside"; +const AlertTagname = "Alert"; /** * remark plugin that converts blocks delimited with `:::` into instances of @@ -29,17 +29,26 @@ const AsideTagname = "Aside"; * * ``` */ -function remarkAsides(): unified.Plugin<[], mdast.Root> { - const variants = new Set(["note", "tip", "caution", "danger"]); +function remarkAlerts(): unified.Plugin<[], mdast.Root> { + const variants = new Set(["erro", "succ", "warn", "info"]); const transformer: unified.Transformer = (tree) => { visit(tree, (node) => { + + if (node.type == "paragraph" && node.data?.directiveLabel) { + console.log(`FOUND A NODE\n`, node) + } + if (node.type !== "containerDirective") return; const type = node.name; if (!variants.has(type)) return; + console.log(node) let title: string | undefined; remove(node, (child) => { + console.log(`-----------------------`) + console.log(child) + if (child.data?.directiveLabel) { if ("children" in child && "value" in child.children[0]) { title = child.children[0].value; @@ -49,8 +58,11 @@ function remarkAsides(): unified.Plugin<[], mdast.Root> { }); const data = node.data || (node.data = {}); - data.hName = AsideTagname; - data.hProperties = h(AsideTagname, { type, title }).properties; + data.hName = 'div'; + data.hProperties = h('div', { class: `alert ${type}` }).properties; + data.children = [ + h('p', {text: title}) + ] }); }; @@ -69,14 +81,14 @@ export function astroAsides(): AstroIntegration { "astro:config:setup": ({ injectScript, updateConfig }) => { updateConfig({ markdown: { - remarkPlugins: [remarkAsides()], + remarkPlugins: [remarkAlerts()], }, }); // Auto-import the Aside component and attach it to the global scope injectScript( "page-ssr", - `import ${AsideTagname} from "~/components/Aside.astro"; console.log(\`imported occured correctly\`)` + `import ${AlertTagname} from "~/components/Alert.astro"; console.log(${AlertTagname})` ); }, }, diff --git a/src/components/Aside.astro b/src/components/Alert.astro similarity index 100% rename from src/components/Aside.astro rename to src/components/Alert.astro diff --git a/src/components/PageContent/PageContent.astro b/src/components/PageContent/PageContent.astro index 72f6e92..f6e7eff 100644 --- a/src/components/PageContent/PageContent.astro +++ b/src/components/PageContent/PageContent.astro @@ -18,7 +18,7 @@ const title = frontmatter.title; diff --git a/src/components/Footer/AvatarList.astro b/src/components/Footer/AvatarList.astro deleted file mode 100644 index e5880a0..0000000 --- a/src/components/Footer/AvatarList.astro +++ /dev/null @@ -1,159 +0,0 @@ ---- -// fetch all commits for just this page's path -const path = 'docs/' + Astro.props.path; -const url = `https://api.github.com/repos/withastro/astro/commits?path=${path}`; -const commitsURL = `https://github.com/withastro/astro/commits/main/${path}`; - -async function getCommits(url) { - try { - const token = import.meta.env.SNOWPACK_PUBLIC_GITHUB_TOKEN; - if (!token) { - throw new Error( - 'Cannot find "SNOWPACK_PUBLIC_GITHUB_TOKEN" used for escaping rate-limiting.' - ); - } - - const auth = `Basic ${Buffer.from(token, 'binary').toString('base64')}`; - - const res = await fetch(url, { - method: 'GET', - headers: { - Authorization: auth, - 'User-Agent': 'astro-docs/1.0', - }, - }); - - const data = await res.json(); - - if (!res.ok) { - throw new Error( - `Request to fetch commits failed. Reason: ${res.statusText} - Message: ${data.message}` - ); - } - - return data; - } catch (e) { - console.warn(`[error] /src/components/AvatarList.astro - ${e?.message ?? e}`); - return new Array(); - } -} - -function removeDups(arr) { - if (!arr) { - return new Array(); - } - let map = new Map(); - - for (let item of arr) { - let author = item.author; - // Deduplicate based on author.id - map.set(author.id, { login: author.login, id: author.id }); - } - - return Array.from(map.values()); -} - -const data = await getCommits(url); -const unique = removeDups(data); -const recentContributors = unique.slice(0, 3); // only show avatars for the 3 most recent contributors -const additionalContributors = unique.length - recentContributors.length; // list the rest of them as # of extra contributors ---- - - -
-
    - {recentContributors.map((item) => ( -
  • - - {`Contributor - -
    • - ))} -
- {additionalContributors > 0 && ( - - {`and ${additionalContributors} additional contributor${ - additionalContributors > 1 ? 's' : '' - }.`} - - )} - {unique.length === 0 && Contributors} -
- - diff --git a/src/components/Footer/Footer.astro b/src/components/Footer/Footer.astro deleted file mode 100644 index 4639e92..0000000 --- a/src/components/Footer/Footer.astro +++ /dev/null @@ -1,17 +0,0 @@ ---- -import AvatarList from './AvatarList.astro'; -const { path } = Astro.props; ---- - -
-

I'm a footer

- -
- - diff --git a/src/components/HeadCommon.astro b/src/components/HeadCommon.astro deleted file mode 100644 index de98a71..0000000 --- a/src/components/HeadCommon.astro +++ /dev/null @@ -1,34 +0,0 @@ ---- -import '../styles/theme.css'; -import '../styles/index.css'; ---- - - - - - - - - - - - - - - - - - - - diff --git a/src/components/HeadSEO.astro b/src/components/HeadSEO.astro deleted file mode 100644 index 74eed9f..0000000 --- a/src/components/HeadSEO.astro +++ /dev/null @@ -1,52 +0,0 @@ ---- -import { Site, OpenGraph } from '../config'; -export interface Props { - frontmatter: any; - site: any; - canonicalURL: URL | string; -} - -const canonicalURL = new URL(Astro.url.pathname, Astro.site); -const { frontmatter = {} } = Astro.props; -const formattedContentTitle = frontmatter.title - ? `${frontmatter.title} - ${Site.title}` - : Site.title; -const imageSrc = frontmatter?.image?.src ?? OpenGraph.image.src; -const canonicalImageSrc = new URL(imageSrc, Astro.site); -const imageAlt = frontmatter?.image?.alt ?? OpenGraph.image.alt; ---- - - - - - - - - - - - - - - - - - - - - - - - diff --git a/src/components/Header/Header.astro b/src/components/Header/Header.astro deleted file mode 100644 index 7fe6591..0000000 --- a/src/components/Header/Header.astro +++ /dev/null @@ -1,139 +0,0 @@ ---- -import { getLanguageFromURL, KNOWN_LANGUAGE_CODES } from '../../languages'; -import * as CONFIG from '../../config'; -import Logo from './Logo.astro'; -import SkipToContent from './SkipToContent.astro'; -import SidebarToggle from './SidebarToggle'; -import LanguageSelect from './LanguageSelect'; -import Search from './Search'; - -const { currentPage } = Astro.props; -const lang = currentPage && getLanguageFromURL(currentPage); ---- - -
- - -
- - diff --git a/src/components/Header/LanguageSelect.tsx b/src/components/Header/LanguageSelect.tsx deleted file mode 100644 index 412dd86..0000000 --- a/src/components/Header/LanguageSelect.tsx +++ /dev/null @@ -1,49 +0,0 @@ -import type { FunctionalComponent } from 'preact'; -import { h } from 'preact'; -import { Langs, langPathRegex } from '../../languages'; - -interface Props { - lang: string -} - -export default function LanguageSelect({ lang = 'en' }: Props) { - return <> -
- - -
- -} \ No newline at end of file diff --git a/src/components/Header/Logo.astro b/src/components/Header/Logo.astro deleted file mode 100644 index e027e35..0000000 --- a/src/components/Header/Logo.astro +++ /dev/null @@ -1,6 +0,0 @@ ---- -const { size } = Astro.props; -const style = `height: 55px;width: 55px; border-radius: 4px;`; ---- - -Higenku Documentation logo \ No newline at end of file diff --git a/src/components/Header/Search.tsx b/src/components/Header/Search.tsx deleted file mode 100644 index 1396543..0000000 --- a/src/components/Header/Search.tsx +++ /dev/null @@ -1,84 +0,0 @@ -import { DocSearchModal, useDocSearchKeyboardEvents } from '@docsearch/react'; -import {Algolia} from '~/config'; -import { createPortal } from 'preact/compat'; -import { useCallback, useEffect, useRef, useState } from 'preact/hooks'; -interface Props { - lang?: string; - // labels: Pick; -} - -export default function Search({ lang = 'en', /*labels*/ }: Props) { - const [isOpen, setIsOpen] = useState(false); - const [initialQuery, setInitialQuery] = useState(); - - const onOpen = useCallback(() => { - setIsOpen(true); - }, [setIsOpen]); - - const onClose = useCallback(() => { - setIsOpen(false); - }, [setIsOpen]); - - const onInput = useCallback( - (e) => { - setIsOpen(true); - setInitialQuery(e.key); - }, - [setIsOpen, setInitialQuery] - ); - - useDocSearchKeyboardEvents({ - isOpen, - onOpen, - onClose, - onInput, - }); - - return <> - {isOpen && createPortal( - `https://gitlab.com/higenku/apps/docs/-/issues/new?issue[title]=[DOC MISSING]+Missing+results+for+query+%22${encodeURIComponent(query)}%22`} - transformItems={(items) => { - return items.map((item) => { - const a = document.createElement('a'); - a.href = item.url; - const hash = a.hash === '#overview' ? '' : a.hash; - return { - ...item, - url: `${a.pathname}${hash}`, - }; - }); - }} - />, - document.body - )} - - - - -} \ No newline at end of file diff --git a/src/components/Header/SidebarToggle.tsx b/src/components/Header/SidebarToggle.tsx deleted file mode 100644 index 2be9dee..0000000 --- a/src/components/Header/SidebarToggle.tsx +++ /dev/null @@ -1,44 +0,0 @@ -import type { FunctionalComponent } from 'preact'; -import { h, Fragment } from 'preact'; -import { useState, useEffect } from 'preact/hooks'; - -const MenuToggle: FunctionalComponent = () => { - const [sidebarShown, setSidebarShown] = useState(false); - - useEffect(() => { - const body = document.getElementsByTagName('body')[0]; - if (sidebarShown) { - body.classList.add('mobile-sidebar-toggle'); - } else { - body.classList.remove('mobile-sidebar-toggle'); - } - }, [sidebarShown]); - - return ( - - ); -}; - -export default MenuToggle; diff --git a/src/components/Header/SkipToContent.astro b/src/components/Header/SkipToContent.astro deleted file mode 100644 index 9e3844e..0000000 --- a/src/components/Header/SkipToContent.astro +++ /dev/null @@ -1,22 +0,0 @@ - - - diff --git a/src/components/LeftSidebar/LeftSidebar.astro b/src/components/LeftSidebar/LeftSidebar.astro deleted file mode 100644 index 7f29d1c..0000000 --- a/src/components/LeftSidebar/LeftSidebar.astro +++ /dev/null @@ -1,128 +0,0 @@ ---- -import { getCurrentBar } from '../../languages'; -import { Sidebar } from '../../config'; -const { currentPage } = Astro.props; -const currentPageMatch = currentPage.slice(1); -const keys = getCurrentBar(Astro.url.pathname) -const key = keys[0] || '/en' - - -// Sidebar is a flat array. Group it by sections to properly render. -//@ts-ignore -const sidebarSections = Sidebar[key].reduce((col, item, i) => { - // If the first item is not a section header, create a new container section. - if (i === 0) { - if (!item.header) { - const pseudoSection = { text: '' }; - //@ts-ignore - col.push({ ...pseudoSection, children: [] }); - } - } - if (item.header) { - //@ts-ignore - col.push({ ...item, children: [] }); - } else { - //@ts-ignore - col[col.length - 1].children.push(item); - } - return col; -}, []); ---- - - - - - - diff --git a/src/components/PageContent/PageContent.astro b/src/components/PageContent/PageContent.astro deleted file mode 100644 index f6e7eff..0000000 --- a/src/components/PageContent/PageContent.astro +++ /dev/null @@ -1,41 +0,0 @@ ---- -import TableOfContents from '../RightSidebar/TableOfContents'; - -const { frontmatter, headings, githubEditUrl } = Astro.props; -const title = frontmatter.title; ---- - -
-
-

{title}

- - -
-
- - diff --git a/src/components/RightSidebar/MoreMenu.astro b/src/components/RightSidebar/MoreMenu.astro deleted file mode 100644 index 233b3c0..0000000 --- a/src/components/RightSidebar/MoreMenu.astro +++ /dev/null @@ -1,67 +0,0 @@ ---- -import * as CONFIG from '../../config'; -const { editHref } = Astro.props; -const showMoreSection = CONFIG.CommunityInvite || editHref; ---- - -{showMoreSection &&

More

} - - - - diff --git a/src/components/RightSidebar/RightSidebar.astro b/src/components/RightSidebar/RightSidebar.astro deleted file mode 100644 index 6144ed9..0000000 --- a/src/components/RightSidebar/RightSidebar.astro +++ /dev/null @@ -1,27 +0,0 @@ ---- -import TableOfContents from './TableOfContents'; -import MoreMenu from './MoreMenu.astro'; -const { headings, githubEditUrl } = Astro.props; ---- - - - - diff --git a/src/components/RightSidebar/TableOfContents.tsx b/src/components/RightSidebar/TableOfContents.tsx deleted file mode 100644 index 2944346..0000000 --- a/src/components/RightSidebar/TableOfContents.tsx +++ /dev/null @@ -1,54 +0,0 @@ -import type { FunctionalComponent } from 'preact'; -import { h, Fragment } from 'preact'; -import { useState, useEffect, useRef, MutableRef } from 'preact/hooks'; -import type { MarkdownHeading } from 'astro'; - -type ItemType = any[] | undefined - - -const TableOfContents: FunctionalComponent<{ headings: MarkdownHeading[] }> = ({ - headings = [], -}) => { - const itemOffsets: MutableRef = useRef([]); - const [activeId, _] = useState(undefined); - useEffect(() => { - const getItemOffsets = () => { - const titles = document.querySelectorAll('article :is(h1, h2, h3, h4)'); - itemOffsets.current = Array.from(titles).map((title) => ({ - id: title.id, - topOffset: title.getBoundingClientRect().top + window.scrollY, - })); - }; - - getItemOffsets(); - window.addEventListener('resize', getItemOffsets); - - return () => { - window.removeEventListener('resize', getItemOffsets); - }; - }, []); - - return ( - <> -

On this page

- - - ); -}; - -export default TableOfContents; diff --git a/src/config.ts b/src/config.ts deleted file mode 100644 index 25b04b2..0000000 --- a/src/config.ts +++ /dev/null @@ -1,82 +0,0 @@ -export const Site = { - title: "XDocs", - description: "Higenku Documentation", - defaultLanguage: "en_US", -}; - -export const OpenGraph = { - image: { - src: "/favicon.png", - alt: "Higenku Centrialized Documentation for all our software", - }, - twitter: "higenku_project", -}; - -export const Langs = { - English: "en", - Deutsch: "de", - Português: "pt", -}; - -// Uncomment this to add an "Edit this page" button to every page of documentation. -export const EditUrl = `https://gitlab.com/-/ide/project/higenku/apps/docs/edit/dev/-/`; - -// Uncomment this to add an "Join our Community" button to every page of documentation. -export const CommunityInvite = `https://higenku.org/support`; -export interface File { - path: string; - pathName: string; -} -const Files = {} - -for (const i in import.meta.glob('./pages/**/*')) { - let file = i.slice("./pages".length, i.length) as string - - if (file.endsWith('index.md')) { - Files[file.replace("/index.md", "")] = `src/pages${file}` - } - - else if (file.endsWith('index.astro')) { - let pathName = file.replace("/index.astro", ""); - if (pathName.length == 0) { - pathName = "/" - } - - Files[pathName] = `src/pages${file}`; - } - else - Files[file.replace(".md", "")] = `src/pages${file}` -} -export {Files} -// Uncomment this to enable site search. -// See "Algolia" section of the README for more information. -export const Algolia = { - indexName: "XXXXXXXXXX", - appId: "XXXXXXXXXX", - apiKey: "XXXXXXXXXX", -}; - -export const Sidebar = { - "/en/page-2": [ - { text: "Hello", header: true }, - { text: "Section Header", header: true }, - { text: "Introduction", link: "/en/" }, - { text: "Page 2", link: "/en/page-2" }, - { text: "Page 3", link: "/en/page-3" }, - - { text: "Another Section", header: true }, - { text: "Page 4", link: "/en/page-4" }, - ], - - "/en": [ - { text: "", header: true }, - { text: "Section Header", header: true }, - { text: "Introduction", link: "/en/" }, - { text: "Page 2", link: "/en/page-2" }, - { text: "Page 3", link: "/en/page-3" }, - - { text: "Another Section", header: true }, - { text: "Page 4", link: "/en/page-4" }, - ], -}; - diff --git a/src/env.d.ts b/src/env.d.ts deleted file mode 100644 index f964fe0..0000000 --- a/src/env.d.ts +++ /dev/null @@ -1 +0,0 @@ -/// diff --git a/src/languages.ts b/src/languages.ts deleted file mode 100644 index 3f38f36..0000000 --- a/src/languages.ts +++ /dev/null @@ -1,24 +0,0 @@ -import { Langs, Sidebar } from './config'; - -export { Langs }; -export const KNOWN_LANGUAGE_CODES = Object.values(Langs); -export const langPathRegex = /\/([a-z]{2}-?[A-Z]{0,2})\//; - -export function getLanguageFromURL(pathname: string): string { - const langCodeMatch = pathname.match(langPathRegex); - return langCodeMatch ? langCodeMatch[1] : 'en'; -} - - -export function getCurrentBar(pathname: string): string[] { - let res = [] - for (let ele of Object.keys(Sidebar)) { - - if (pathname.startsWith(ele)) { - res.push(ele) - } - - } - - return res -} \ No newline at end of file diff --git a/src/layouts/MainLayout.astro b/src/layouts/MainLayout.astro deleted file mode 100644 index 4aa715c..0000000 --- a/src/layouts/MainLayout.astro +++ /dev/null @@ -1,135 +0,0 @@ ---- -import HeadCommon from '../components/HeadCommon.astro'; -import HeadSEO from '../components/HeadSEO.astro'; -import Header from '../components/Header/Header.astro'; -import PageContent from '../components/PageContent/PageContent.astro'; -import LeftSidebar from '../components/LeftSidebar/LeftSidebar.astro'; -import RightSidebar from '../components/RightSidebar/RightSidebar.astro'; -import * as config from '../config'; - -const { frontmatter = {}, headings } = Astro.props; -const canonicalURL = new URL(Astro.url.pathname, Astro.site); -let currentPage = Astro.url.pathname; -if (currentPage.endsWith("/")) { - currentPage = currentPage.slice(0, currentPage.length - 1) -} -const currentFile = config.Files[currentPage]; - -const githubEditUrl = config.EditUrl + currentFile; ---- - - - - - - - - - - - - - {frontmatter.title ? `${frontmatter.title} - ${config.Site.title}` : config.Site.title} - - - - - -
-
- -
- - - -
- -
- - diff --git a/src/layouts/SimpleLayout.astro b/src/layouts/SimpleLayout.astro deleted file mode 100644 index 1048796..0000000 --- a/src/layouts/SimpleLayout.astro +++ /dev/null @@ -1,129 +0,0 @@ ---- -import HeadCommon from '../components/HeadCommon.astro'; -import HeadSEO from '../components/HeadSEO.astro'; -import Header from '../components/Header/Header.astro'; -import PageContent from '../components/PageContent/PageContent.astro'; -import LeftSidebar from '../components/LeftSidebar/LeftSidebar.astro'; -import RightSidebar from '../components/RightSidebar/RightSidebar.astro'; -import * as config from '../config'; - -const { frontmatter = {}, headings } = Astro.props; -const canonicalURL = new URL(Astro.url.pathname, Astro.site); -let currentPage = Astro.url.pathname; -if (currentPage.endsWith("/")) { - currentPage = currentPage.slice(0, currentPage.length - 1) -} -const currentFile = config.Files[currentPage]; - -const githubEditUrl = config.EditUrl + currentFile; ---- - - - - - - - - - - - - - {frontmatter.title ? `${frontmatter.title} - ${config.Site.title}` : config.Site.title} - - - - - -
-
- -
- -
-
- - diff --git a/src/pages/404.astro b/src/pages/404.astro deleted file mode 100644 index fdf0112..0000000 --- a/src/pages/404.astro +++ /dev/null @@ -1,8 +0,0 @@ ---- -import Layout from "~/layouts/SimpleLayout.astro" -import P404 from "~/components/404.svelte" ---- - - - - \ No newline at end of file diff --git a/src/pages/en/tools/bak/index.md b/src/pages/en/tools/bak/index.md deleted file mode 100644 index e69de29..0000000 diff --git a/src/pages/en/tools/pacman/index.md b/src/pages/en/tools/pacman/index.md deleted file mode 100644 index e69de29..0000000 diff --git a/src/pages/index.astro b/src/pages/index.astro deleted file mode 100644 index 1acabc8..0000000 --- a/src/pages/index.astro +++ /dev/null @@ -1,5 +0,0 @@ - diff --git a/src/styles/index.css b/src/styles/index.css deleted file mode 100644 index fd7905f..0000000 --- a/src/styles/index.css +++ /dev/null @@ -1,521 +0,0 @@ -.language-select { - flex-grow: 1; - width: 48px; - box-sizing: border-box; - margin: 0; - padding: 0.33em 0.5em; - overflow: visible; - font-weight: 500; - font-size: 1rem; - font-family: inherit; - line-height: inherit; - background-color: var(--body-color); - border-color: var(--theme-text-lighter); - color: var(--cl-text); - border-style: solid; - border-width: 1px; - border-radius: 0.25rem; - outline: 0; - cursor: pointer; - transition-timing-function: ease-out; - transition-duration: 0.2s; - transition-property: border-color, color; - -webkit-font-smoothing: antialiased; - padding-left: 30px; - padding-right: 1rem; -} -.language-select-wrapper .language-select:hover, -.language-select-wrapper .language-select:focus { - color: var(--theme-text); - border-color: var(--theme-text-light); -} -.language-select-wrapper { - /* color: var(--theme-text-light); */ - position: relative; -} -.language-select-wrapper > svg { - position: absolute; - top: 7px; - left: 10px; - pointer-events: none; -} - -@media (min-width: 50em) { - .language-select { - width: 100%; - } -} - - -/** Style Algolia */ -.search-input { - flex-grow: 1; - box-sizing: border-box; - width: 100%; - margin: 0; - padding: 0.33em 0.5em; - overflow: visible; - font-weight: 500; - font-size: 1rem; - font-family: inherit; - line-height: inherit; - background-color: var(--theme-divider); - border-color: var(--theme-divider); - color: var(--theme-text-light); - border-color: var(--cl-shade-light); - border-style: solid; - border-width: 1px; - border-radius: 0.25rem; - outline: 0; - cursor: pointer; - transition-timing-function: ease-out; - transition-duration: 0.2s; - transition-property: border-color, color; - -webkit-font-smoothing: antialiased; -} -.search-input:hover, -.search-input:focus { - color: var(--theme-text); - border-color: var(--theme-text-light); -} -.search-input:hover::placeholder, -.search-input:focus::placeholder { - color: var(--theme-text-light); -} -.search-input::placeholder { - color: var(--theme-text-light); -} -.search-hint { - position: absolute; - top: 7px; - right: 19px; - padding: 3px 5px; - display: none; - display: none; - align-items: center; - justify-content: center; - letter-spacing: 0.125em; - font-size: 13px; - font-family: var(--font-mono); - pointer-events: none; - border-color: var(--theme-text-lighter); - color: var(--theme-text-light); - border-style: solid; - border-width: 1px; - border-radius: 0.25rem; - line-height: 14px; -} - -@media (min-width: 50em) { - .search-hint { - display: flex; - } -} - -/* ------------------------------------------------------------ *\ - DocSearch (Algolia) -\* ------------------------------------------------------------ */ - -:root { - - --docsearch-searchbox-background: var(--cl-shade-light); - --docsearch-primary-color: var(--cl-text); - --docsearch-modal-background: var(--body-color); - --docsearch-searchbox-focus-background: var(--theme-bg-offset); - --docsearch-footer-background: var(--cl-shade-light); - --docsearch-text-color: var(--cl-text); - --docsearch-hit-background: var(--body-color); - --docsearch-hit-shadow: none; - --docsearch-hit-color: var(--cl-text); - --docsearch-container-background: rgba(0, 0, 0, 0.6); - --docsearch-hit-active-color: rgba(0,0,0, 1); - --docsearch-modal-shadow: none; - --docsearch-footer-shadow: none; -} - -* { - box-sizing: border-box; - margin: 0; -} - -ul { - list-style: circle; -} - -/* Global focus outline reset */ -*:focus:not(:focus-visible) { - outline: none; -} - -:root { - --user-font-scale: 1rem - 16px; - --max-width: calc(100% - 1rem); -} - -@media (min-width: 50em) { - :root { - --max-width: 100%; - } -} - -body { - display: flex; - flex-direction: column; - min-height: 100vh; - font-family: var(--font-body); - font-size: 1rem; - font-size: clamp(0.9rem, 0.75rem + 0.375vw + var(--user-font-scale), 1rem); - line-height: 1.5; - max-width: 100vw; -} - -nav ul { - list-style: none; - padding: 0; -} - -.content > section > * + * { - margin-top: 1.25rem; -} - -.content > section > :first-child { - margin-top: 0; -} - -/* Typography */ -h1, -h2, -h3, -h4, -h5, -h6 { - margin-bottom: 1rem; - font-weight: bold; - line-height: 1; -} - -h1, -h2 { - max-width: 40ch; -} - -:is(h2, h3):not(:first-child) { - margin-top: 3rem; -} - -:is(h4, h5, h6):not(:first-child) { - margin-top: 2rem; -} - -h1 { - font-size: 3.25rem; - font-weight: 800; -} - -h2 { - font-size: 2.5rem; -} - -h3 { - font-size: 1.75rem; -} - -h4 { - font-size: 1.3rem; -} - -h5 { - font-size: 1rem; -} - -p { - line-height: 1.65em; -} - -.content ul { - line-height: 1.1em; -} - -p, -.content ul { - color: var(--theme-text-light); -} - -small, -.text_small { - font-size: 0.833rem; -} - -a { - color: var(--theme-text-accent); - font-weight: 400; - text-underline-offset: 0.08em; - align-items: center; - gap: 0.5rem; -} - -article > section :is(ul, ol) > * + * { - margin-top: 0.75rem; -} - -article > section nav :is(ul, ol) > * + * { - margin-top: inherit; -} - -article > section li > :is(p, pre, blockquote):not(:first-child) { - margin-top: 1rem; -} - -article > section :is(ul, ol) { - padding-left: 1em; -} - -article > section nav :is(ul, ol) { - padding-left: inherit; -} - -article > section nav { - margin-top: 1rem; - margin-bottom: 2rem; -} - -article > section ::marker { - font-weight: bold; - color: var(--theme-text-light); -} - -article > section iframe { - width: 100%; - height: auto; - aspect-ratio: 16 / 9; -} - -a > code { - position: relative; - color: var(--theme-text-accent); - background: transparent; - text-underline-offset: var(--padding-block); -} - -a > code::before { - content: ''; - position: absolute; - top: 0; - right: 0; - bottom: 0; - left: 0; - display: block; - background: var(--theme-accent); - opacity: var(--theme-accent-opacity); - border-radius: var(--border-radius); -} - -a:hover, -a:focus { - text-decoration: underline; -} - -a:focus { - outline: 2px solid currentColor; - outline-offset: 0.25em; -} - -strong { - font-weight: 600; - color: inherit; -} - -/* Supporting Content */ - -code { - --border-radius: 3px; - --padding-block: 0.2rem; - --padding-inline: 0.33rem; - - font-family: var(--font-mono); - font-size: 0.85em; - color: inherit; - background-color: var(--theme-code-inline-bg); - padding: var(--padding-block) var(--padding-inline); - margin: calc(var(--padding-block) * -1) -0.125em; - border-radius: var(--border-radius); - word-break: break-word; -} - -pre.astro-code > code { - all: unset; -} - -pre > code { - font-size: 1em; -} - -table, -pre { - position: relative; - --padding-block: 1rem; - --padding-inline: 2rem; - padding: var(--padding-block) var(--padding-inline); - padding-right: calc(var(--padding-inline) * 2); - margin-left: calc(var(--padding-inline) * -1); - margin-right: calc(var(--padding-inline) * -1); - font-family: var(--font-mono); - - line-height: 1.5; - font-size: 0.85em; - overflow-y: hidden; - overflow-x: auto; -} - -table { - width: 100%; - padding: var(--padding-block) 0; - margin: 0; - border-collapse: collapse; -} - -/* Zebra striping */ -tr:nth-of-type(odd) { - background: var(--theme-bg-hover); -} -th { - background: var(--color-black); - color: var(--theme-color); - font-weight: bold; -} -td, -th { - padding: 6px; - text-align: left; -} - -pre { - background-color: var(--theme-code-bg); - color: var(--theme-code-text); -} - -blockquote code { - background-color: var(--theme-bg); -} - -@media (min-width: 37.75em) { - pre { - --padding-inline: 1.25rem; - border-radius: 8px; - margin-left: 0; - margin-right: 0; - } -} - -blockquote { - margin: 2rem 0; - padding: 1.25em 1.5rem; - border-left: 3px solid var(--theme-text-light); - background-color: var(--theme-bg-offset); - border-radius: 0 0.25rem 0.25rem 0; - line-height: 1.7; -} - -img { - max-width: 100%; -} - -.flex { - display: flex; - align-items: center; -} - -button { - display: flex; - align-items: center; - justify-items: center; - gap: 0.25em; - padding: 0.33em 0.67em; - border: 0; - background: var(--theme-bg); - display: flex; - font-size: 1rem; - align-items: center; - gap: 0.25em; - border-radius: 99em; - color: var(--theme-text); - background-color: var(--theme-bg); -} - -h2.heading { - font-size: 1rem; - font-weight: 700; - padding: 0.1rem 1rem; - text-transform: uppercase; - margin-bottom: 0.5rem; -} - -.heading-link { - font-size: 1rem; - padding: 0.1rem 0 0.1rem 1rem; - border-left: 4px solid var(--theme-divider); -} - -.heading-link:hover, -.heading-link:focus { - border-left-color: var(--theme-accent); - color: var(--theme-accent); -} -.heading-link:focus-within { - color: var(--theme-text-light); - border-left-color: hsla(var(--color-gray-40), 1); -} -.heading-link svg { - opacity: 0.6; -} -.heading-link:hover svg { - opacity: 0.8; -} -.heading-link a { - display: inline-flex; - gap: 0.5em; - width: 100%; - padding: 0.15em 0 0.15em 0; -} - -.heading-link.depth-3 { - padding-left: 2rem; -} -.heading-link.depth-4 { - padding-left: 3rem; -} - -.heading-link a { - font: inherit; - color: inherit; - text-decoration: none; -} - -/* Screenreader Only Text */ -.sr-only { - position: absolute; - width: 1px; - height: 1px; - padding: 0; - margin: -1px; - overflow: hidden; - clip: rect(0, 0, 0, 0); - white-space: nowrap; - border-width: 0; -} - -.focus\:not-sr-only:focus, -.focus\:not-sr-only:focus-visible { - position: static; - width: auto; - height: auto; - padding: 0; - margin: 0; - overflow: visible; - clip: auto; - white-space: normal; -} - -:target { - scroll-margin: calc(var(--theme-sidebar-offset, 5rem) + 2rem) 0 2rem; -} diff --git a/src/styles/theme.css b/src/styles/theme.css deleted file mode 100644 index 9834b65..0000000 --- a/src/styles/theme.css +++ /dev/null @@ -1,97 +0,0 @@ -:root { - --font-fallback: -apple-system, BlinkMacSystemFont, Segoe UI, Helvetica, Arial, sans-serif, - Apple Color Emoji, Segoe UI Emoji; - --font-body: system-ui, var(--font-fallback); - --font-mono: 'IBM Plex Mono', Consolas, 'Andale Mono WT', 'Andale Mono', 'Lucida Console', - 'Lucida Sans Typewriter', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Liberation Mono', - 'Nimbus Mono L', Monaco, 'Courier New', Courier, monospace; - - /* - * Variables with --color-base prefix define - * the hue, and saturation values to be used for - * hsla colors. - * - * ex: - * - * --color-base-{color}: {hue}, {saturation}; - * - */ - - --color-base-white: 0, 0%; - --color-base-black: 240, 100%; - --color-base-gray: 215, 14%; - --color-base-blue: 212, 100%; - --color-base-blue-dark: 212, 72%; - --color-base-green: 158, 79%; - --color-base-orange: 22, 100%; - --color-base-purple: 269, 79%; - --color-base-red: 351, 100%; - --color-base-yellow: 41, 100%; - - /* - * Color palettes are made using --color-base - * variables, along with a lightness value to - * define different variants. - * - */ - - --color-gray-5: var(--color-base-gray), 5%; - --color-gray-10: var(--color-base-gray), 10%; - --color-gray-20: var(--color-base-gray), 20%; - --color-gray-30: var(--color-base-gray), 30%; - --color-gray-40: var(--color-base-gray), 40%; - --color-gray-50: var(--color-base-gray), 50%; - --color-gray-60: var(--color-base-gray), 60%; - --color-gray-70: var(--color-base-gray), 70%; - --color-gray-80: var(--color-base-gray), 80%; - --color-gray-90: var(--color-base-gray), 90%; - --color-gray-95: var(--color-base-gray), 95%; - - --color-blue: var(--color-base-blue), 61%; - --color-blue-dark: var(--color-base-blue-dark), 39%; - --color-green: var(--color-base-green), 42%; - --color-orange: var(--color-base-orange), 50%; - --color-purple: var(--color-base-purple), 54%; - --color-red: var(--color-base-red), 54%; - --color-yellow: var(--color-base-yellow), 59%; -} - -:root { - color-scheme: dark; - --docsearch-modal-background: var(--theme-bg); - --theme-accent-opacity: 0.15; - --theme-accent: hsla(var(--color-blue), 1); - --theme-text-accent: hsla(var(--color-blue), 1); - --theme-divider: hsla(var(--color-gray-10), 1); - --theme-text: hsla(var(--color-gray-90), 1); - --theme-text-light: hsla(var(--color-gray-80), 1); - - /* @@@: not used anywhere */ - --theme-text-lighter: hsla(var(--color-gray-40), 1); - --theme-bg: hsla(215, 28%, 17%, 1); - --theme-bg-hover: hsla(var(--color-gray-40), 1); - --theme-bg-offset: hsla(var(--color-gray-5), 1); - --theme-code-inline-bg: hsla(var(--color-gray-10), 1); - --theme-code-inline-text: hsla(var(--color-base-white), 100%, 1); - --theme-code-bg: hsla(var(--color-gray-5), 1); - --theme-code-text: hsla(var(--color-base-white), 100%, 1); - --theme-navbar-bg: hsla(215, 28%, 17%, 1); - --theme-selection-color: hsla(var(--color-base-white), 100%, 1); - --theme-selection-bg: hsla(var(--color-purple), var(--theme-accent-opacity)); - - /* DocSearch [Algolia] */ - --docsearch-modal-background: var(--theme-bg); - --docsearch-searchbox-focus-background: var(--theme-divider); - --docsearch-footer-background: var(--theme-divider); - --docsearch-text-color: var(--theme-text); - --docsearch-hit-background: var(--theme-divider); - --docsearch-hit-shadow: none; - --docsearch-hit-color: var(--theme-text); - --docsearch-footer-shadow: inset 0 2px 10px #000; - --docsearch-modal-shadow: inset 0 0 8px #000; -} - -::selection { - color: var(--theme-selection-color); - background-color: var(--theme-selection-bg); -} -- GitLab From 4d734ba1ccd4b15bc7f62c37d5b1415c6d8584f6 Mon Sep 17 00:00:00 2001 From: lmtr0 Date: Mon, 12 Dec 2022 22:49:04 -0300 Subject: [PATCH 06/16] Mkdocs working --- .editorconfig | 3 + .gitignore | 20 +- .gitlab-ci.yml | 12 +- .gitmodules | 3 + .npmrc | 2 - Pipfile | 16 + Pipfile.lock | 478 ++ astro.config.ts | 47 - {src/pages/en => docs}/apps/account/index.md | 0 {src/pages/en => docs}/apps/client/index.md | 0 {src/pages/en => docs}/apps/index.md | 0 {src/pages/en => docs}/apps/store/index.md | 0 {src/pages/en => docs}/apps/suite/index.md | 0 .../guide/CrossPlatformDevelopment.md | 0 {src/pages/en => docs}/guide/XRuntime.md | 0 {src/pages/en => docs}/guide/XStore.md | 0 {src/pages/en => docs}/guide/index.md | 0 {src/pages/en => docs}/guide/ways/cncpp.md | 0 {src/pages/en => docs}/guide/ways/csharp.md | 0 {src/pages/en => docs}/guide/ways/custom.md | 0 {src/pages/en => docs}/guide/ways/java.md | 0 .../guide/ways/javascript/electron.md | 0 .../guide/ways/javascript/index.md | 0 .../guide/ways/javascript/javascript.md | 0 .../en => docs}/guide/ways/javascript/nwjs.md | 0 .../guide/ways/javascript/tauri.md | 0 {src/pages/en => docs}/guide/ways/kotin.md | 0 {src/pages/en => docs}/guide/ways/pwa.md | 0 {src/pages/en => docs}/guide/ways/python.md | 0 {src/pages/en => docs}/guide/ways/rust.md | 0 docs/index.md | 1 + {src/pages/en => docs}/packs/index.md | 0 {src/pages/en => docs}/runtimes/index.md | 0 {src/pages/en => docs}/sdks/index.md | 0 .../en => docs}/sdks/krome/architecture.md | 0 {src/pages/en => docs}/sdks/krome/examples.md | 0 .../pages/en => docs}/sdks/krome/functions.md | 0 {src/pages/en => docs}/sdks/krome/index.md | 0 {src/pages/en => docs}/sdks/theme/index.md | 0 {src/pages/en => docs}/testapps/index.md | 0 {src/pages/en => docs}/tools/index.md | 0 docs/tools/packer/index.md | 34 + integration/remark.ts | 96 - integration/tables.ts | 42 - makefile | 4 + mkdocs.yml | 115 + package.json | 47 +- pnpm-lock.yaml | 4218 ++--------------- public/favicon.png | Bin 7892 -> 0 bytes public/make-scrollable-code-focusable.js | 3 - reqs.txt | 23 + scripts/package.json | 16 - scripts/sitemap.js | 26 - src/components/404.svelte | 17 - src/components/Alert.astro | 128 - src/components/Footer/AvatarList.astro | 159 - src/components/Footer/Footer.astro | 17 - src/components/HeadCommon.astro | 34 - src/components/HeadSEO.astro | 52 - src/components/Header/Header.astro | 139 - src/components/Header/LanguageSelect.tsx | 49 - src/components/Header/Logo.astro | 6 - src/components/Header/Search.tsx | 84 - src/components/Header/SidebarToggle.tsx | 44 - src/components/Header/SkipToContent.astro | 22 - src/components/LeftSidebar/LeftSidebar.astro | 128 - src/components/PageContent/PageContent.astro | 41 - src/components/RightSidebar/MoreMenu.astro | 67 - .../RightSidebar/RightSidebar.astro | 27 - .../RightSidebar/TableOfContents.tsx | 54 - src/config.ts | 82 - src/env.d.ts | 1 - src/languages.ts | 24 - src/layouts/MainLayout.astro | 135 - src/layouts/SimpleLayout.astro | 129 - src/pages/404.astro | 8 - src/pages/de/index.md | 8 - src/pages/en/index.md | 54 - src/pages/en/page-2.md | 51 - src/pages/en/page-3.md | 37 - src/pages/en/page-4.md | 37 - src/pages/en/tools/packer/index.md | 3 - src/pages/index.astro | 5 - src/pages/pt/index.md | 2 - src/styles/index.css | 521 -- src/styles/theme.css | 97 - tsconfig.json | 20 - 87 files changed, 1177 insertions(+), 6311 deletions(-) create mode 100644 .gitmodules delete mode 100644 .npmrc create mode 100644 Pipfile create mode 100644 Pipfile.lock delete mode 100644 astro.config.ts rename {src/pages/en => docs}/apps/account/index.md (100%) rename {src/pages/en => docs}/apps/client/index.md (100%) rename {src/pages/en => docs}/apps/index.md (100%) rename {src/pages/en => docs}/apps/store/index.md (100%) rename {src/pages/en => docs}/apps/suite/index.md (100%) rename {src/pages/en => docs}/guide/CrossPlatformDevelopment.md (100%) rename {src/pages/en => docs}/guide/XRuntime.md (100%) rename {src/pages/en => docs}/guide/XStore.md (100%) rename {src/pages/en => docs}/guide/index.md (100%) rename {src/pages/en => docs}/guide/ways/cncpp.md (100%) rename {src/pages/en => docs}/guide/ways/csharp.md (100%) rename {src/pages/en => docs}/guide/ways/custom.md (100%) rename {src/pages/en => docs}/guide/ways/java.md (100%) rename {src/pages/en => docs}/guide/ways/javascript/electron.md (100%) rename {src/pages/en => docs}/guide/ways/javascript/index.md (100%) rename {src/pages/en => docs}/guide/ways/javascript/javascript.md (100%) rename {src/pages/en => docs}/guide/ways/javascript/nwjs.md (100%) rename {src/pages/en => docs}/guide/ways/javascript/tauri.md (100%) rename {src/pages/en => docs}/guide/ways/kotin.md (100%) rename {src/pages/en => docs}/guide/ways/pwa.md (100%) rename {src/pages/en => docs}/guide/ways/python.md (100%) rename {src/pages/en => docs}/guide/ways/rust.md (100%) create mode 100644 docs/index.md rename {src/pages/en => docs}/packs/index.md (100%) rename {src/pages/en => docs}/runtimes/index.md (100%) rename {src/pages/en => docs}/sdks/index.md (100%) rename {src/pages/en => docs}/sdks/krome/architecture.md (100%) rename {src/pages/en => docs}/sdks/krome/examples.md (100%) rename {src/pages/en => docs}/sdks/krome/functions.md (100%) rename {src/pages/en => docs}/sdks/krome/index.md (100%) rename {src/pages/en => docs}/sdks/theme/index.md (100%) rename {src/pages/en => docs}/testapps/index.md (100%) rename {src/pages/en => docs}/tools/index.md (100%) create mode 100644 docs/tools/packer/index.md delete mode 100644 integration/remark.ts delete mode 100644 integration/tables.ts create mode 100644 makefile create mode 100644 mkdocs.yml delete mode 100644 public/favicon.png delete mode 100644 public/make-scrollable-code-focusable.js create mode 100644 reqs.txt delete mode 100644 scripts/package.json delete mode 100644 scripts/sitemap.js delete mode 100644 src/components/404.svelte delete mode 100644 src/components/Alert.astro delete mode 100644 src/components/Footer/AvatarList.astro delete mode 100644 src/components/Footer/Footer.astro delete mode 100644 src/components/HeadCommon.astro delete mode 100644 src/components/HeadSEO.astro delete mode 100644 src/components/Header/Header.astro delete mode 100644 src/components/Header/LanguageSelect.tsx delete mode 100644 src/components/Header/Logo.astro delete mode 100644 src/components/Header/Search.tsx delete mode 100644 src/components/Header/SidebarToggle.tsx delete mode 100644 src/components/Header/SkipToContent.astro delete mode 100644 src/components/LeftSidebar/LeftSidebar.astro delete mode 100644 src/components/PageContent/PageContent.astro delete mode 100644 src/components/RightSidebar/MoreMenu.astro delete mode 100644 src/components/RightSidebar/RightSidebar.astro delete mode 100644 src/components/RightSidebar/TableOfContents.tsx delete mode 100644 src/config.ts delete mode 100644 src/env.d.ts delete mode 100644 src/languages.ts delete mode 100644 src/layouts/MainLayout.astro delete mode 100644 src/layouts/SimpleLayout.astro delete mode 100644 src/pages/404.astro delete mode 100644 src/pages/de/index.md delete mode 100644 src/pages/en/index.md delete mode 100644 src/pages/en/page-2.md delete mode 100644 src/pages/en/page-3.md delete mode 100644 src/pages/en/page-4.md delete mode 100644 src/pages/en/tools/packer/index.md delete mode 100644 src/pages/index.astro delete mode 100644 src/pages/pt/index.md delete mode 100644 src/styles/index.css delete mode 100644 src/styles/theme.css delete mode 100644 tsconfig.json diff --git a/.editorconfig b/.editorconfig index c1322dc..585e82e 100644 --- a/.editorconfig +++ b/.editorconfig @@ -3,6 +3,9 @@ # top-most EditorConfig file root = true +[makefile, Makefile] +indent_style = tab + [*] indent_style = space indent_size = 4 diff --git a/.gitignore b/.gitignore index 02f6e50..ccbfadb 100644 --- a/.gitignore +++ b/.gitignore @@ -1,19 +1 @@ -# build output -dist/ - -# dependencies -node_modules/ - -# logs -npm-debug.log* -yarn-debug.log* -yarn-error.log* -pnpm-debug.log* - - -# environment variables -.env -.env.production - -# macOS-specific files -.DS_Store +site/ \ No newline at end of file diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 73daab0..a8e394b 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -5,16 +5,16 @@ stages: - deploy build: + image: python stage: build before_script: - - npm i -g pnpm - - pnpm config set store-dir .pnpm-store + - pip install --upgrade pip + - pip install -r reqs.txt script: - - pnpm i - - pnpm build + - mkdocs build artifacts: paths: - - dist + - site expire_in: 1 days deploy: @@ -26,4 +26,4 @@ deploy: - git checkout $CI_COMMIT_BRANCH - pnpm config set store-dir .pnpm-store script: - - CLOUDFLARE_ACCOUNT_ID=$CF_ACCOUNT CLOUDFLARE_API_TOKEN="$CF_TOKEN" wrangler pages publish dist --project-name higenku-docs \ No newline at end of file + - CLOUDFLARE_ACCOUNT_ID=$CF_ACCOUNT CLOUDFLARE_API_TOKEN="$CF_TOKEN" wrangler pages publish site --project-name higenku-docs \ No newline at end of file diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 0000000..31e5f61 --- /dev/null +++ b/.gitmodules @@ -0,0 +1,3 @@ +[submodule "theme"] + path = theme + url = https://github.com/vuejs/vitepress.git diff --git a/.npmrc b/.npmrc deleted file mode 100644 index ef83021..0000000 --- a/.npmrc +++ /dev/null @@ -1,2 +0,0 @@ -# Expose Astro dependencies for `pnpm` users -shamefully-hoist=true diff --git a/Pipfile b/Pipfile new file mode 100644 index 0000000..9f08b84 --- /dev/null +++ b/Pipfile @@ -0,0 +1,16 @@ +[[source]] +url = "https://pypi.org/simple" +verify_ssl = true +name = "pypi" + +[packages] +mkdocs-material = "*" +mkdocs = "*" +sphinx = "*" +myst-parser = "*" +sphinx-autobuild = "*" + +[dev-packages] + +[requires] +python_version = "3.10" diff --git a/Pipfile.lock b/Pipfile.lock new file mode 100644 index 0000000..5f62225 --- /dev/null +++ b/Pipfile.lock @@ -0,0 +1,478 @@ +{ + "_meta": { + "hash": { + "sha256": "9df98ce853b3e3d2f70f05c6033d1511db844e6cd2fb59e614688626cf3c72ac" + }, + "pipfile-spec": 6, + "requires": { + "python_version": "3.10" + }, + "sources": [ + { + "name": "pypi", + "url": "https://pypi.org/simple", + "verify_ssl": true + } + ] + }, + "default": { + "alabaster": { + "hashes": [ + "sha256:446438bdcca0e05bd45ea2de1668c1d9b032e1a9154c2c259092d77031ddd359", + "sha256:a661d72d58e6ea8a57f7a86e37d86716863ee5e92788398526d58b26a4e4dc02" + ], + "version": "==0.7.12" + }, + "babel": { + "hashes": [ + "sha256:1ad3eca1c885218f6dce2ab67291178944f810a10a9b5f3cb8382a5a232b64fe", + "sha256:5ef4b3226b0180dedded4229651c8b0e1a3a6a2837d45a073272f313e4cf97f6" + ], + "markers": "python_version >= '3.6'", + "version": "==2.11.0" + }, + "certifi": { + "hashes": [ + "sha256:35824b4c3a97115964b408844d64aa14db1cc518f6562e8d7261699d1350a9e3", + "sha256:4ad3232f5e926d6718ec31cfc1fcadfde020920e278684144551c91769c7bc18" + ], + "markers": "python_version >= '3.6'", + "version": "==2022.12.7" + }, + "charset-normalizer": { + "hashes": [ + "sha256:5a3d016c7c547f69d6f81fb0db9449ce888b418b5b9952cc5e6e66843e9dd845", + "sha256:83e9a75d1911279afd89352c68b45348559d1fc0506b054b346651b5e7fee29f" + ], + "markers": "python_full_version >= '3.6.0'", + "version": "==2.1.1" + }, + "click": { + "hashes": [ + "sha256:7682dc8afb30297001674575ea00d1814d808d6a36af415a82bd481d37ba7b8e", + "sha256:bb4d8133cb15a609f44e8213d9b391b0809795062913b383c62be0ee95b1db48" + ], + "markers": "python_version >= '3.7'", + "version": "==8.1.3" + }, + "colorama": { + "hashes": [ + "sha256:08695f5cb7ed6e0531a20572697297273c47b8cae5a63ffc6d6ed5c201be6e44", + "sha256:4f1d9991f5acc0ca119f9d443620b77f9d6b33703e51011c16baf57afb285fc6" + ], + "markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4, 3.5, 3.6'", + "version": "==0.4.6" + }, + "docutils": { + "hashes": [ + "sha256:33995a6753c30b7f577febfc2c50411fec6aac7f7ffeb7c4cfe5991072dcf9e6", + "sha256:5e1de4d849fee02c63b040a4a3fd567f4ab104defd8a5511fbbc24a8a017efbc" + ], + "markers": "python_version >= '3.7'", + "version": "==0.19" + }, + "ghp-import": { + "hashes": [ + "sha256:8337dd7b50877f163d4c0289bc1f1c7f127550241988d568c1db512c4324a619", + "sha256:9c535c4c61193c2df8871222567d7fd7e5014d835f97dc7b7439069e2413d343" + ], + "version": "==2.1.0" + }, + "idna": { + "hashes": [ + "sha256:814f528e8dead7d329833b91c5faa87d60bf71824cd12a7530b5526063d02cb4", + "sha256:90b77e79eaa3eba6de819a0c442c0b4ceefc341a7a2ab77d7562bf49f425c5c2" + ], + "markers": "python_version >= '3.5'", + "version": "==3.4" + }, + "imagesize": { + "hashes": [ + "sha256:0d8d18d08f840c19d0ee7ca1fd82490fdc3729b7ac93f49870406ddde8ef8d8b", + "sha256:69150444affb9cb0d5cc5a92b3676f0b2fb7cd9ae39e947a5e11a36b4497cd4a" + ], + "markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3'", + "version": "==1.4.1" + }, + "jinja2": { + "hashes": [ + "sha256:31351a702a408a9e7595a8fc6150fc3f43bb6bf7e319770cbc0db9df9437e852", + "sha256:6088930bfe239f0e6710546ab9c19c9ef35e29792895fed6e6e31a023a182a61" + ], + "markers": "python_version >= '3.7'", + "version": "==3.1.2" + }, + "livereload": { + "hashes": [ + "sha256:776f2f865e59fde56490a56bcc6773b6917366bce0c267c60ee8aaf1a0959869" + ], + "version": "==2.6.3" + }, + "markdown": { + "hashes": [ + "sha256:cbb516f16218e643d8e0a95b309f77eb118cb138d39a4f27851e6a63581db874", + "sha256:f5da449a6e1c989a4cea2631aa8ee67caa5a2ef855d551c88f9e309f4634c621" + ], + "markers": "python_version >= '3.6'", + "version": "==3.3.7" + }, + "markdown-it-py": { + "hashes": [ + "sha256:93de681e5c021a432c63147656fe21790bc01231e0cd2da73626f1aa3ac0fe27", + "sha256:cf7e59fed14b5ae17c0006eff14a2d9a00ed5f3a846148153899a0224e2c07da" + ], + "markers": "python_version >= '3.7'", + "version": "==2.1.0" + }, + "markupsafe": { + "hashes": [ + "sha256:0212a68688482dc52b2d45013df70d169f542b7394fc744c02a57374a4207003", + "sha256:089cf3dbf0cd6c100f02945abeb18484bd1ee57a079aefd52cffd17fba910b88", + "sha256:10c1bfff05d95783da83491be968e8fe789263689c02724e0c691933c52994f5", + "sha256:33b74d289bd2f5e527beadcaa3f401e0df0a89927c1559c8566c066fa4248ab7", + "sha256:3799351e2336dc91ea70b034983ee71cf2f9533cdff7c14c90ea126bfd95d65a", + "sha256:3ce11ee3f23f79dbd06fb3d63e2f6af7b12db1d46932fe7bd8afa259a5996603", + "sha256:421be9fbf0ffe9ffd7a378aafebbf6f4602d564d34be190fc19a193232fd12b1", + "sha256:43093fb83d8343aac0b1baa75516da6092f58f41200907ef92448ecab8825135", + "sha256:46d00d6cfecdde84d40e572d63735ef81423ad31184100411e6e3388d405e247", + "sha256:4a33dea2b688b3190ee12bd7cfa29d39c9ed176bda40bfa11099a3ce5d3a7ac6", + "sha256:4b9fe39a2ccc108a4accc2676e77da025ce383c108593d65cc909add5c3bd601", + "sha256:56442863ed2b06d19c37f94d999035e15ee982988920e12a5b4ba29b62ad1f77", + "sha256:671cd1187ed5e62818414afe79ed29da836dde67166a9fac6d435873c44fdd02", + "sha256:694deca8d702d5db21ec83983ce0bb4b26a578e71fbdbd4fdcd387daa90e4d5e", + "sha256:6a074d34ee7a5ce3effbc526b7083ec9731bb3cbf921bbe1d3005d4d2bdb3a63", + "sha256:6d0072fea50feec76a4c418096652f2c3238eaa014b2f94aeb1d56a66b41403f", + "sha256:6fbf47b5d3728c6aea2abb0589b5d30459e369baa772e0f37a0320185e87c980", + "sha256:7f91197cc9e48f989d12e4e6fbc46495c446636dfc81b9ccf50bb0ec74b91d4b", + "sha256:86b1f75c4e7c2ac2ccdaec2b9022845dbb81880ca318bb7a0a01fbf7813e3812", + "sha256:8dc1c72a69aa7e082593c4a203dcf94ddb74bb5c8a731e4e1eb68d031e8498ff", + "sha256:8e3dcf21f367459434c18e71b2a9532d96547aef8a871872a5bd69a715c15f96", + "sha256:8e576a51ad59e4bfaac456023a78f6b5e6e7651dcd383bcc3e18d06f9b55d6d1", + "sha256:96e37a3dc86e80bf81758c152fe66dbf60ed5eca3d26305edf01892257049925", + "sha256:97a68e6ada378df82bc9f16b800ab77cbf4b2fada0081794318520138c088e4a", + "sha256:99a2a507ed3ac881b975a2976d59f38c19386d128e7a9a18b7df6fff1fd4c1d6", + "sha256:a49907dd8420c5685cfa064a1335b6754b74541bbb3706c259c02ed65b644b3e", + "sha256:b09bf97215625a311f669476f44b8b318b075847b49316d3e28c08e41a7a573f", + "sha256:b7bd98b796e2b6553da7225aeb61f447f80a1ca64f41d83612e6139ca5213aa4", + "sha256:b87db4360013327109564f0e591bd2a3b318547bcef31b468a92ee504d07ae4f", + "sha256:bcb3ed405ed3222f9904899563d6fc492ff75cce56cba05e32eff40e6acbeaa3", + "sha256:d4306c36ca495956b6d568d276ac11fdd9c30a36f1b6eb928070dc5360b22e1c", + "sha256:d5ee4f386140395a2c818d149221149c54849dfcfcb9f1debfe07a8b8bd63f9a", + "sha256:dda30ba7e87fbbb7eab1ec9f58678558fd9a6b8b853530e176eabd064da81417", + "sha256:e04e26803c9c3851c931eac40c695602c6295b8d432cbe78609649ad9bd2da8a", + "sha256:e1c0b87e09fa55a220f058d1d49d3fb8df88fbfab58558f1198e08c1e1de842a", + "sha256:e72591e9ecd94d7feb70c1cbd7be7b3ebea3f548870aa91e2732960fa4d57a37", + "sha256:e8c843bbcda3a2f1e3c2ab25913c80a3c5376cd00c6e8c4a86a89a28c8dc5452", + "sha256:efc1913fd2ca4f334418481c7e595c00aad186563bbc1ec76067848c7ca0a933", + "sha256:f121a1420d4e173a5d96e47e9a0c0dcff965afdf1626d28de1460815f7c4ee7a", + "sha256:fc7b548b17d238737688817ab67deebb30e8073c95749d55538ed473130ec0c7" + ], + "markers": "python_version >= '3.7'", + "version": "==2.1.1" + }, + "mdit-py-plugins": { + "hashes": [ + "sha256:36d08a29def19ec43acdcd8ba471d3ebab132e7879d442760d963f19913e04b9", + "sha256:5cfd7e7ac582a594e23ba6546a2f406e94e42eb33ae596d0734781261c251260" + ], + "markers": "python_version >= '3.7'", + "version": "==0.3.3" + }, + "mdurl": { + "hashes": [ + "sha256:84008a41e51615a49fc9966191ff91509e3c40b939176e643fd50a5c2196b8f8", + "sha256:bb413d29f5eea38f31dd4754dd7377d4465116fb207585f97bf925588687c1ba" + ], + "markers": "python_version >= '3.7'", + "version": "==0.1.2" + }, + "mergedeep": { + "hashes": [ + "sha256:0096d52e9dad9939c3d975a774666af186eda617e6ca84df4c94dec30004f2a8", + "sha256:70775750742b25c0d8f36c55aed03d24c3384d17c951b3175d898bd778ef0307" + ], + "markers": "python_version >= '3.6'", + "version": "==1.3.4" + }, + "mkdocs": { + "hashes": [ + "sha256:8947af423a6d0facf41ea1195b8e1e8c85ad94ac95ae307fe11232e0424b11c5", + "sha256:c8856a832c1e56702577023cd64cc5f84948280c1c0fcc6af4cd39006ea6aa8c" + ], + "index": "pypi", + "version": "==1.4.2" + }, + "mkdocs-material": { + "hashes": [ + "sha256:b0ea0513fd8cab323e8a825d6692ea07fa83e917bb5db042e523afecc7064ab7", + "sha256:c907b4b052240a5778074a30a78f31a1f8ff82d7012356dc26898b97559f082e" + ], + "index": "pypi", + "version": "==8.5.11" + }, + "mkdocs-material-extensions": { + "hashes": [ + "sha256:9c003da71e2cc2493d910237448c672e00cefc800d3d6ae93d2fc69979e3bd93", + "sha256:e41d9f38e4798b6617ad98ca8f7f1157b1e4385ac1459ca1e4ea219b556df945" + ], + "markers": "python_version >= '3.7'", + "version": "==1.1.1" + }, + "myst-parser": { + "hashes": [ + "sha256:61b275b85d9f58aa327f370913ae1bec26ebad372cc99f3ab85c8ec3ee8d9fb8", + "sha256:79317f4bb2c13053dd6e64f9da1ba1da6cd9c40c8a430c447a7b146a594c246d" + ], + "index": "pypi", + "version": "==0.18.1" + }, + "packaging": { + "hashes": [ + "sha256:2198ec20bd4c017b8f9717e00f0c8714076fc2fd93816750ab48e2c41de2cfd3", + "sha256:957e2148ba0e1a3b282772e791ef1d8083648bc131c8ab0c1feba110ce1146c3" + ], + "markers": "python_version >= '3.7'", + "version": "==22.0" + }, + "pygments": { + "hashes": [ + "sha256:56a8508ae95f98e2b9bdf93a6be5ae3f7d8af858b43e02c5a2ff083726be40c1", + "sha256:f643f331ab57ba3c9d89212ee4a2dabc6e94f117cf4eefde99a0574720d14c42" + ], + "markers": "python_version >= '3.6'", + "version": "==2.13.0" + }, + "pymdown-extensions": { + "hashes": [ + "sha256:0f8fb7b74a37a61cc34e90b2c91865458b713ec774894ffad64353a5fce85cfc", + "sha256:ac698c15265680db5eb13cd4342abfcde2079ac01e5486028f47a1b41547b859" + ], + "markers": "python_version >= '3.7'", + "version": "==9.9" + }, + "python-dateutil": { + "hashes": [ + "sha256:0123cacc1627ae19ddf3c27a5de5bd67ee4586fbdd6440d9748f8abb483d3e86", + "sha256:961d03dc3453ebbc59dbdea9e4e11c5651520a876d0f4db161e8674aae935da9" + ], + "markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3'", + "version": "==2.8.2" + }, + "pytz": { + "hashes": [ + "sha256:222439474e9c98fced559f1709d89e6c9cbf8d79c794ff3eb9f8800064291427", + "sha256:e89512406b793ca39f5971bc999cc538ce125c0e51c27941bef4568b460095e2" + ], + "version": "==2022.6" + }, + "pyyaml": { + "hashes": [ + "sha256:01b45c0191e6d66c470b6cf1b9531a771a83c1c4208272ead47a3ae4f2f603bf", + "sha256:0283c35a6a9fbf047493e3a0ce8d79ef5030852c51e9d911a27badfde0605293", + "sha256:055d937d65826939cb044fc8c9b08889e8c743fdc6a32b33e2390f66013e449b", + "sha256:07751360502caac1c067a8132d150cf3d61339af5691fe9e87803040dbc5db57", + "sha256:0b4624f379dab24d3725ffde76559cff63d9ec94e1736b556dacdfebe5ab6d4b", + "sha256:0ce82d761c532fe4ec3f87fc45688bdd3a4c1dc5e0b4a19814b9009a29baefd4", + "sha256:1e4747bc279b4f613a09eb64bba2ba602d8a6664c6ce6396a4d0cd413a50ce07", + "sha256:213c60cd50106436cc818accf5baa1aba61c0189ff610f64f4a3e8c6726218ba", + "sha256:231710d57adfd809ef5d34183b8ed1eeae3f76459c18fb4a0b373ad56bedcdd9", + "sha256:277a0ef2981ca40581a47093e9e2d13b3f1fbbeffae064c1d21bfceba2030287", + "sha256:2cd5df3de48857ed0544b34e2d40e9fac445930039f3cfe4bcc592a1f836d513", + "sha256:40527857252b61eacd1d9af500c3337ba8deb8fc298940291486c465c8b46ec0", + "sha256:432557aa2c09802be39460360ddffd48156e30721f5e8d917f01d31694216782", + "sha256:473f9edb243cb1935ab5a084eb238d842fb8f404ed2193a915d1784b5a6b5fc0", + "sha256:48c346915c114f5fdb3ead70312bd042a953a8ce5c7106d5bfb1a5254e47da92", + "sha256:50602afada6d6cbfad699b0c7bb50d5ccffa7e46a3d738092afddc1f9758427f", + "sha256:68fb519c14306fec9720a2a5b45bc9f0c8d1b9c72adf45c37baedfcd949c35a2", + "sha256:77f396e6ef4c73fdc33a9157446466f1cff553d979bd00ecb64385760c6babdc", + "sha256:81957921f441d50af23654aa6c5e5eaf9b06aba7f0a19c18a538dc7ef291c5a1", + "sha256:819b3830a1543db06c4d4b865e70ded25be52a2e0631ccd2f6a47a2822f2fd7c", + "sha256:897b80890765f037df3403d22bab41627ca8811ae55e9a722fd0392850ec4d86", + "sha256:98c4d36e99714e55cfbaaee6dd5badbc9a1ec339ebfc3b1f52e293aee6bb71a4", + "sha256:9df7ed3b3d2e0ecfe09e14741b857df43adb5a3ddadc919a2d94fbdf78fea53c", + "sha256:9fa600030013c4de8165339db93d182b9431076eb98eb40ee068700c9c813e34", + "sha256:a80a78046a72361de73f8f395f1f1e49f956c6be882eed58505a15f3e430962b", + "sha256:afa17f5bc4d1b10afd4466fd3a44dc0e245382deca5b3c353d8b757f9e3ecb8d", + "sha256:b3d267842bf12586ba6c734f89d1f5b871df0273157918b0ccefa29deb05c21c", + "sha256:b5b9eccad747aabaaffbc6064800670f0c297e52c12754eb1d976c57e4f74dcb", + "sha256:bfaef573a63ba8923503d27530362590ff4f576c626d86a9fed95822a8255fd7", + "sha256:c5687b8d43cf58545ade1fe3e055f70eac7a5a1a0bf42824308d868289a95737", + "sha256:cba8c411ef271aa037d7357a2bc8f9ee8b58b9965831d9e51baf703280dc73d3", + "sha256:d15a181d1ecd0d4270dc32edb46f7cb7733c7c508857278d3d378d14d606db2d", + "sha256:d4b0ba9512519522b118090257be113b9468d804b19d63c71dbcf4a48fa32358", + "sha256:d4db7c7aef085872ef65a8fd7d6d09a14ae91f691dec3e87ee5ee0539d516f53", + "sha256:d4eccecf9adf6fbcc6861a38015c2a64f38b9d94838ac1810a9023a0609e1b78", + "sha256:d67d839ede4ed1b28a4e8909735fc992a923cdb84e618544973d7dfc71540803", + "sha256:daf496c58a8c52083df09b80c860005194014c3698698d1a57cbcfa182142a3a", + "sha256:dbad0e9d368bb989f4515da330b88a057617d16b6a8245084f1b05400f24609f", + "sha256:e61ceaab6f49fb8bdfaa0f92c4b57bcfbea54c09277b1b4f7ac376bfb7a7c174", + "sha256:f84fbc98b019fef2ee9a1cb3ce93e3187a6df0b2538a651bfb890254ba9f90b5" + ], + "markers": "python_version >= '3.6'", + "version": "==6.0" + }, + "pyyaml-env-tag": { + "hashes": [ + "sha256:70092675bda14fdec33b31ba77e7543de9ddc88f2e5b99160396572d11525bdb", + "sha256:af31106dec8a4d68c60207c1886031cbf839b68aa7abccdb19868200532c2069" + ], + "markers": "python_version >= '3.6'", + "version": "==0.1" + }, + "requests": { + "hashes": [ + "sha256:7c5599b102feddaa661c826c56ab4fee28bfd17f5abca1ebbe3e7f19d7c97983", + "sha256:8fefa2a1a1365bf5520aac41836fbee479da67864514bdb821f31ce07ce65349" + ], + "markers": "python_version >= '3.7' and python_version < '4'", + "version": "==2.28.1" + }, + "six": { + "hashes": [ + "sha256:1e61c37477a1626458e36f7b1d82aa5c9b094fa4802892072e49de9c60c4c926", + "sha256:8abb2f1d86890a2dfb989f9a77cfcfd3e47c2a354b01111771326f8aa26e0254" + ], + "markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3'", + "version": "==1.16.0" + }, + "snowballstemmer": { + "hashes": [ + "sha256:09b16deb8547d3412ad7b590689584cd0fe25ec8db3be37788be3810cbf19cb1", + "sha256:c8e1716e83cc398ae16824e5572ae04e0d9fc2c6b985fb0f900f5f0c96ecba1a" + ], + "version": "==2.2.0" + }, + "sphinx": { + "hashes": [ + "sha256:060ca5c9f7ba57a08a1219e547b269fadf125ae25b06b9fa7f66768efb652d6d", + "sha256:51026de0a9ff9fc13c05d74913ad66047e104f56a129ff73e174eb5c3ee794b5" + ], + "index": "pypi", + "version": "==5.3.0" + }, + "sphinx-autobuild": { + "hashes": [ + "sha256:8fe8cbfdb75db04475232f05187c776f46f6e9e04cacf1e49ce81bdac649ccac", + "sha256:de1ca3b66e271d2b5b5140c35034c89e47f263f2cd5db302c9217065f7443f05" + ], + "index": "pypi", + "version": "==2021.3.14" + }, + "sphinxcontrib-applehelp": { + "hashes": [ + "sha256:806111e5e962be97c29ec4c1e7fe277bfd19e9652fb1a4392105b43e01af885a", + "sha256:a072735ec80e7675e3f432fcae8610ecf509c5f1869d17e2eecff44389cdbc58" + ], + "markers": "python_version >= '3.5'", + "version": "==1.0.2" + }, + "sphinxcontrib-devhelp": { + "hashes": [ + "sha256:8165223f9a335cc1af7ffe1ed31d2871f325254c0423bc0c4c7cd1c1e4734a2e", + "sha256:ff7f1afa7b9642e7060379360a67e9c41e8f3121f2ce9164266f61b9f4b338e4" + ], + "markers": "python_version >= '3.5'", + "version": "==1.0.2" + }, + "sphinxcontrib-htmlhelp": { + "hashes": [ + "sha256:d412243dfb797ae3ec2b59eca0e52dac12e75a241bf0e4eb861e450d06c6ed07", + "sha256:f5f8bb2d0d629f398bf47d0d69c07bc13b65f75a81ad9e2f71a63d4b7a2f6db2" + ], + "markers": "python_version >= '3.6'", + "version": "==2.0.0" + }, + "sphinxcontrib-jsmath": { + "hashes": [ + "sha256:2ec2eaebfb78f3f2078e73666b1415417a116cc848b72e5172e596c871103178", + "sha256:a9925e4a4587247ed2191a22df5f6970656cb8ca2bd6284309578f2153e0c4b8" + ], + "markers": "python_version >= '3.5'", + "version": "==1.0.1" + }, + "sphinxcontrib-qthelp": { + "hashes": [ + "sha256:4c33767ee058b70dba89a6fc5c1892c0d57a54be67ddd3e7875a18d14cba5a72", + "sha256:bd9fc24bcb748a8d51fd4ecaade681350aa63009a347a8c14e637895444dfab6" + ], + "markers": "python_version >= '3.5'", + "version": "==1.0.3" + }, + "sphinxcontrib-serializinghtml": { + "hashes": [ + "sha256:352a9a00ae864471d3a7ead8d7d79f5fc0b57e8b3f95e9867eb9eb28999b92fd", + "sha256:aa5f6de5dfdf809ef505c4895e51ef5c9eac17d0f287933eb49ec495280b6952" + ], + "markers": "python_version >= '3.5'", + "version": "==1.1.5" + }, + "tornado": { + "hashes": [ + "sha256:1d54d13ab8414ed44de07efecb97d4ef7c39f7438cf5e976ccd356bebb1b5fca", + "sha256:20f638fd8cc85f3cbae3c732326e96addff0a15e22d80f049e00121651e82e72", + "sha256:5c87076709343557ef8032934ce5f637dbb552efa7b21d08e89ae7619ed0eb23", + "sha256:5f8c52d219d4995388119af7ccaa0bcec289535747620116a58d830e7c25d8a8", + "sha256:6fdfabffd8dfcb6cf887428849d30cf19a3ea34c2c248461e1f7d718ad30b66b", + "sha256:87dcafae3e884462f90c90ecc200defe5e580a7fbbb4365eda7c7c1eb809ebc9", + "sha256:9b630419bde84ec666bfd7ea0a4cb2a8a651c2d5cccdbdd1972a0c859dfc3c13", + "sha256:b8150f721c101abdef99073bf66d3903e292d851bee51910839831caba341a75", + "sha256:ba09ef14ca9893954244fd872798b4ccb2367c165946ce2dd7376aebdde8e3ac", + "sha256:d3a2f5999215a3a06a4fc218026cd84c61b8b2b40ac5296a6db1f1451ef04c1e", + "sha256:e5f923aa6a47e133d1cf87d60700889d7eae68988704e20c75fb2d65677a8e4b" + ], + "markers": "python_version > '2.7'", + "version": "==6.2" + }, + "typing-extensions": { + "hashes": [ + "sha256:1511434bb92bf8dd198c12b1cc812e800d4181cfcb867674e0f8279cc93087aa", + "sha256:16fa4864408f655d35ec496218b85f79b3437c829e93320c7c9215ccfd92489e" + ], + "markers": "python_version >= '3.7'", + "version": "==4.4.0" + }, + "urllib3": { + "hashes": [ + "sha256:47cc05d99aaa09c9e72ed5809b60e7ba354e64b59c9c173ac3018642d8bb41fc", + "sha256:c083dd0dce68dbfbe1129d5271cb90f9447dea7d52097c6e0126120c521ddea8" + ], + "markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4, 3.5'", + "version": "==1.26.13" + }, + "watchdog": { + "hashes": [ + "sha256:1893d425ef4fb4f129ee8ef72226836619c2950dd0559bba022b0818c63a7b60", + "sha256:1a410dd4d0adcc86b4c71d1317ba2ea2c92babaf5b83321e4bde2514525544d5", + "sha256:1f2b0665c57358ce9786f06f5475bc083fea9d81ecc0efa4733fd0c320940a37", + "sha256:1f8eca9d294a4f194ce9df0d97d19b5598f310950d3ac3dd6e8d25ae456d4c8a", + "sha256:27e49268735b3c27310883012ab3bd86ea0a96dcab90fe3feb682472e30c90f3", + "sha256:28704c71afdb79c3f215c90231e41c52b056ea880b6be6cee035c6149d658ed1", + "sha256:2ac0bd7c206bb6df78ef9e8ad27cc1346f2b41b1fef610395607319cdab89bc1", + "sha256:2af1a29fd14fc0a87fb6ed762d3e1ae5694dcde22372eebba50e9e5be47af03c", + "sha256:3a048865c828389cb06c0bebf8a883cec3ae58ad3e366bcc38c61d8455a3138f", + "sha256:441024df19253bb108d3a8a5de7a186003d68564084576fecf7333a441271ef7", + "sha256:56fb3f40fc3deecf6e518303c7533f5e2a722e377b12507f6de891583f1b48aa", + "sha256:619d63fa5be69f89ff3a93e165e602c08ed8da402ca42b99cd59a8ec115673e1", + "sha256:74535e955359d79d126885e642d3683616e6d9ab3aae0e7dcccd043bd5a3ff4f", + "sha256:76a2743402b794629a955d96ea2e240bd0e903aa26e02e93cd2d57b33900962b", + "sha256:83cf8bc60d9c613b66a4c018051873d6273d9e45d040eed06d6a96241bd8ec01", + "sha256:920a4bda7daa47545c3201a3292e99300ba81ca26b7569575bd086c865889090", + "sha256:9e99c1713e4436d2563f5828c8910e5ff25abd6ce999e75f15c15d81d41980b6", + "sha256:a5bd9e8656d07cae89ac464ee4bcb6f1b9cecbedc3bf1334683bed3d5afd39ba", + "sha256:ad0150536469fa4b693531e497ffe220d5b6cd76ad2eda474a5e641ee204bbb6", + "sha256:af4b5c7ba60206759a1d99811b5938ca666ea9562a1052b410637bb96ff97512", + "sha256:c7bd98813d34bfa9b464cf8122e7d4bec0a5a427399094d2c17dd5f70d59bc61", + "sha256:ceaa9268d81205876bedb1069f9feab3eccddd4b90d9a45d06a0df592a04cae9", + "sha256:cf05e6ff677b9655c6e9511d02e9cc55e730c4e430b7a54af9c28912294605a4", + "sha256:d0fb5f2b513556c2abb578c1066f5f467d729f2eb689bc2db0739daf81c6bb7e", + "sha256:d6ae890798a3560688b441ef086bb66e87af6b400a92749a18b856a134fc0318", + "sha256:e5aed2a700a18c194c39c266900d41f3db0c1ebe6b8a0834b9995c835d2ca66e", + "sha256:e722755d995035dd32177a9c633d158f2ec604f2a358b545bba5bed53ab25bca", + "sha256:ed91c3ccfc23398e7aa9715abf679d5c163394b8cad994f34f156d57a7c163dc" + ], + "markers": "python_version >= '3.6'", + "version": "==2.2.0" + } + }, + "develop": {} +} diff --git a/astro.config.ts b/astro.config.ts deleted file mode 100644 index d24ddb6..0000000 --- a/astro.config.ts +++ /dev/null @@ -1,47 +0,0 @@ -import type { AstroUserConfig } from "astro/config"; -import preact from "@astrojs/preact"; -import react from "@astrojs/react"; -import { astroAsides } from "./integration/remark"; -import { trasnformTables } from "./integration/tables"; -import vitePreact from "@preact/preset-vite"; -import sitemap from "@astrojs/sitemap"; -import svelte from "@astrojs/svelte"; -import remarkGfm from "remark-gfm" -import remarkDirective from "remark-directive" - -const config: AstroUserConfig = { - integrations: [ - preact({ compat: true }), - svelte(), - sitemap({ - i18n: { - defaultLocale: "en", - locales: { - en: "English", - }, - }, - }), - astroAsides(), - ], - site: `http://docs.higenku.org`, - vite: { - plugins: [vitePreact()], - }, - sitemap: true, - markdown: { - syntaxHighlight: "shiki", - shikiConfig: { - theme: "dracula", - }, - remarkPlugins: [ - remarkGfm, - remarkDirective, - trasnformTables, - ], - rehypePlugins: [ - ], - extendDefaultPlugins: true, - }, -}; - -export default config; diff --git a/src/pages/en/apps/account/index.md b/docs/apps/account/index.md similarity index 100% rename from src/pages/en/apps/account/index.md rename to docs/apps/account/index.md diff --git a/src/pages/en/apps/client/index.md b/docs/apps/client/index.md similarity index 100% rename from src/pages/en/apps/client/index.md rename to docs/apps/client/index.md diff --git a/src/pages/en/apps/index.md b/docs/apps/index.md similarity index 100% rename from src/pages/en/apps/index.md rename to docs/apps/index.md diff --git a/src/pages/en/apps/store/index.md b/docs/apps/store/index.md similarity index 100% rename from src/pages/en/apps/store/index.md rename to docs/apps/store/index.md diff --git a/src/pages/en/apps/suite/index.md b/docs/apps/suite/index.md similarity index 100% rename from src/pages/en/apps/suite/index.md rename to docs/apps/suite/index.md diff --git a/src/pages/en/guide/CrossPlatformDevelopment.md b/docs/guide/CrossPlatformDevelopment.md similarity index 100% rename from src/pages/en/guide/CrossPlatformDevelopment.md rename to docs/guide/CrossPlatformDevelopment.md diff --git a/src/pages/en/guide/XRuntime.md b/docs/guide/XRuntime.md similarity index 100% rename from src/pages/en/guide/XRuntime.md rename to docs/guide/XRuntime.md diff --git a/src/pages/en/guide/XStore.md b/docs/guide/XStore.md similarity index 100% rename from src/pages/en/guide/XStore.md rename to docs/guide/XStore.md diff --git a/src/pages/en/guide/index.md b/docs/guide/index.md similarity index 100% rename from src/pages/en/guide/index.md rename to docs/guide/index.md diff --git a/src/pages/en/guide/ways/cncpp.md b/docs/guide/ways/cncpp.md similarity index 100% rename from src/pages/en/guide/ways/cncpp.md rename to docs/guide/ways/cncpp.md diff --git a/src/pages/en/guide/ways/csharp.md b/docs/guide/ways/csharp.md similarity index 100% rename from src/pages/en/guide/ways/csharp.md rename to docs/guide/ways/csharp.md diff --git a/src/pages/en/guide/ways/custom.md b/docs/guide/ways/custom.md similarity index 100% rename from src/pages/en/guide/ways/custom.md rename to docs/guide/ways/custom.md diff --git a/src/pages/en/guide/ways/java.md b/docs/guide/ways/java.md similarity index 100% rename from src/pages/en/guide/ways/java.md rename to docs/guide/ways/java.md diff --git a/src/pages/en/guide/ways/javascript/electron.md b/docs/guide/ways/javascript/electron.md similarity index 100% rename from src/pages/en/guide/ways/javascript/electron.md rename to docs/guide/ways/javascript/electron.md diff --git a/src/pages/en/guide/ways/javascript/index.md b/docs/guide/ways/javascript/index.md similarity index 100% rename from src/pages/en/guide/ways/javascript/index.md rename to docs/guide/ways/javascript/index.md diff --git a/src/pages/en/guide/ways/javascript/javascript.md b/docs/guide/ways/javascript/javascript.md similarity index 100% rename from src/pages/en/guide/ways/javascript/javascript.md rename to docs/guide/ways/javascript/javascript.md diff --git a/src/pages/en/guide/ways/javascript/nwjs.md b/docs/guide/ways/javascript/nwjs.md similarity index 100% rename from src/pages/en/guide/ways/javascript/nwjs.md rename to docs/guide/ways/javascript/nwjs.md diff --git a/src/pages/en/guide/ways/javascript/tauri.md b/docs/guide/ways/javascript/tauri.md similarity index 100% rename from src/pages/en/guide/ways/javascript/tauri.md rename to docs/guide/ways/javascript/tauri.md diff --git a/src/pages/en/guide/ways/kotin.md b/docs/guide/ways/kotin.md similarity index 100% rename from src/pages/en/guide/ways/kotin.md rename to docs/guide/ways/kotin.md diff --git a/src/pages/en/guide/ways/pwa.md b/docs/guide/ways/pwa.md similarity index 100% rename from src/pages/en/guide/ways/pwa.md rename to docs/guide/ways/pwa.md diff --git a/src/pages/en/guide/ways/python.md b/docs/guide/ways/python.md similarity index 100% rename from src/pages/en/guide/ways/python.md rename to docs/guide/ways/python.md diff --git a/src/pages/en/guide/ways/rust.md b/docs/guide/ways/rust.md similarity index 100% rename from src/pages/en/guide/ways/rust.md rename to docs/guide/ways/rust.md diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..c7c17d9 --- /dev/null +++ b/docs/index.md @@ -0,0 +1 @@ +# Hello world \ No newline at end of file diff --git a/src/pages/en/packs/index.md b/docs/packs/index.md similarity index 100% rename from src/pages/en/packs/index.md rename to docs/packs/index.md diff --git a/src/pages/en/runtimes/index.md b/docs/runtimes/index.md similarity index 100% rename from src/pages/en/runtimes/index.md rename to docs/runtimes/index.md diff --git a/src/pages/en/sdks/index.md b/docs/sdks/index.md similarity index 100% rename from src/pages/en/sdks/index.md rename to docs/sdks/index.md diff --git a/src/pages/en/sdks/krome/architecture.md b/docs/sdks/krome/architecture.md similarity index 100% rename from src/pages/en/sdks/krome/architecture.md rename to docs/sdks/krome/architecture.md diff --git a/src/pages/en/sdks/krome/examples.md b/docs/sdks/krome/examples.md similarity index 100% rename from src/pages/en/sdks/krome/examples.md rename to docs/sdks/krome/examples.md diff --git a/src/pages/en/sdks/krome/functions.md b/docs/sdks/krome/functions.md similarity index 100% rename from src/pages/en/sdks/krome/functions.md rename to docs/sdks/krome/functions.md diff --git a/src/pages/en/sdks/krome/index.md b/docs/sdks/krome/index.md similarity index 100% rename from src/pages/en/sdks/krome/index.md rename to docs/sdks/krome/index.md diff --git a/src/pages/en/sdks/theme/index.md b/docs/sdks/theme/index.md similarity index 100% rename from src/pages/en/sdks/theme/index.md rename to docs/sdks/theme/index.md diff --git a/src/pages/en/testapps/index.md b/docs/testapps/index.md similarity index 100% rename from src/pages/en/testapps/index.md rename to docs/testapps/index.md diff --git a/src/pages/en/tools/index.md b/docs/tools/index.md similarity index 100% rename from src/pages/en/tools/index.md rename to docs/tools/index.md diff --git a/docs/tools/packer/index.md b/docs/tools/packer/index.md new file mode 100644 index 0000000..413b024 --- /dev/null +++ b/docs/tools/packer/index.md @@ -0,0 +1,34 @@ +--- +title: Introduction +description: Docs intro +layout: ~/layouts/MainLayout.astro +--- +# XPacker +Our application ecossystem focus on making tools that will make the life of the developer easier. One of them is our Packer. Instead of worrying about configuration files, system entries and other very specific details of application installing and updating, let us do that while you worry about making the best app possible. + +This application is the first actor of our distribution system. It packs the application to various packs for various systems, or (if the language you are using is interpreted. i.e. Python, Javascript, Java, Kotlin and Perl) One pack for all of them. + +:::warn[Attention] +It's not always that the Interpreted language is going to use the all system package, depending on your needs it may be better to use the normal package instead. +::: + +The tool to help you create XPackages from your application and distribute it across platforms. It has support for `macos`, `windows` and `linux`. +The packer is programmed so that you can use it the way you want with the `custom` extension, or with one of our language ready extensions that take care of the packing and publishing of applications. + +## What are the supported languages? +At the current time we have support for: + +
+ +|Language | Status | Documentation | +| --- | --- | --- | +| Custom |
Ready
| Not Documented | +| Rust |
Ready
| Not Documented | +| Builders (cmake, ...) |
Ready
| Not Documented | +| Python |
Ready
| Not Documented | +| Typescript / Javascript |
Devel
| Not Documented | +| Java |
Devel
| Not Documented | +| Kotlin |
Devel
| Not Documented | +| Libraries |
Devel
| Not Documented | + +
diff --git a/integration/remark.ts b/integration/remark.ts deleted file mode 100644 index cebdc36..0000000 --- a/integration/remark.ts +++ /dev/null @@ -1,96 +0,0 @@ -import type { AstroIntegration } from "astro"; -import type * as mdast from "mdast"; -import type * as unified from "unified"; -import { h } from "hastscript"; -import remarkDirective from "remark-directive"; -import { visit } from "unist-util-visit"; -import { remove } from "unist-util-remove"; - -const AlertTagname = "Alert"; - -/** - * remark plugin that converts blocks delimited with `:::` into instances of - * the `