From efe1dffc06446d26e128aa634107eaeab7e268c8 Mon Sep 17 00:00:00 2001 From: Dongdong Zhou Date: Thu, 11 Apr 2024 22:04:32 +0100 Subject: [PATCH] start docs --- .gitignore | 1 + docs/config.toml | 16 + docs/content/actions/_index.md | 6 + docs/content/actions/command.md | 3 + docs/content/actions/copy.md | 3 + docs/content/actions/file.md | 36 ++ docs/content/actions/package.md | 3 + docs/content/blog/_index.md | 6 + docs/content/blog/first.md | 37 ++ docs/static/styles/styles.css | 649 +++++++++++++++++++++++++++++++ docs/styles/styles.css | 32 ++ docs/tailwind.config.js | 16 + docs/templates/actions-item.html | 10 + docs/templates/actions.html | 9 + docs/templates/base.html | 21 + docs/templates/blog-page.html | 11 + docs/templates/blog.html | 13 + 17 files changed, 872 insertions(+) create mode 100644 docs/config.toml create mode 100644 docs/content/actions/_index.md create mode 100644 docs/content/actions/command.md create mode 100644 docs/content/actions/copy.md create mode 100644 docs/content/actions/file.md create mode 100644 docs/content/actions/package.md create mode 100644 docs/content/blog/_index.md create mode 100644 docs/content/blog/first.md create mode 100644 docs/static/styles/styles.css create mode 100644 docs/styles/styles.css create mode 100644 docs/tailwind.config.js create mode 100644 docs/templates/actions-item.html create mode 100644 docs/templates/actions.html create mode 100644 docs/templates/base.html create mode 100644 docs/templates/blog-page.html create mode 100644 docs/templates/blog.html diff --git a/.gitignore b/.gitignore index ea8c4bf..6e3e1fe 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,2 @@ /target +/docs/public diff --git a/docs/config.toml b/docs/config.toml new file mode 100644 index 0000000..fd43dbb --- /dev/null +++ b/docs/config.toml @@ -0,0 +1,16 @@ +# The URL the site will be built for +base_url = "https://tiron.run" + +# Whether to automatically compile all Sass files in the sass directory +compile_sass = false + +# Whether to build a search index to be used later on by a JavaScript library +build_search_index = false + +[markdown] +# Whether to do syntax highlighting +# Theme can be customised by setting the `highlight_theme` variable to a theme supported by Zola +highlight_code = false + +[extra] +# Put all your custom variables here diff --git a/docs/content/actions/_index.md b/docs/content/actions/_index.md new file mode 100644 index 0000000..97dc511 --- /dev/null +++ b/docs/content/actions/_index.md @@ -0,0 +1,6 @@ ++++ +title = "List of actions" +sort_by = "title" +template = "actions.html" +page_template = "actions-item.html" ++++ \ No newline at end of file diff --git a/docs/content/actions/command.md b/docs/content/actions/command.md new file mode 100644 index 0000000..7520a19 --- /dev/null +++ b/docs/content/actions/command.md @@ -0,0 +1,3 @@ ++++ +title = "command" ++++ diff --git a/docs/content/actions/copy.md b/docs/content/actions/copy.md new file mode 100644 index 0000000..6706fba --- /dev/null +++ b/docs/content/actions/copy.md @@ -0,0 +1,3 @@ ++++ +title = "copy" ++++ diff --git a/docs/content/actions/file.md b/docs/content/actions/file.md new file mode 100644 index 0000000..64f04f1 --- /dev/null +++ b/docs/content/actions/file.md @@ -0,0 +1,36 @@ ++++ +title = "file" ++++ + +# file module + +file + +### Description + +Manage files/folders and their properties + +### Params + +This is my first blog post. + +Another line + +**test**: this is a feature + +### Open Source and Open Standard + +The `Lapdev` core code is open sourced under the AGPL V3 license, with selected features gated under an Enterprise License. + +Before Lapdev, we developed two other open source projects: a code editor Lapce and a native UI toolkit Floem. +Developer environment management software is a crucial component for enhancing developer velocities. +We would not have opted for proprietary software for this purpose ourselves, so it is only logical for us to open source the core code of Lapdev. + +To sustain the development of our open source projects, we've introduced enterprise licensing for certain features. +This enables us to generate revenue that directly supports the ongoing enhancement of Lapdev and our broader open source initiatives. + +Beyond open source, we also favour open standards. +We’ve adopted the devcontainer specification for the definition and configuration of the development environment. +The standard is already supported by popular tools like VSCode, Codespaces and Devpod. +We believe it’s beneficial for developers to have a single format to define their development environment as code, +and to be able to use it across different tools. \ No newline at end of file diff --git a/docs/content/actions/package.md b/docs/content/actions/package.md new file mode 100644 index 0000000..3440955 --- /dev/null +++ b/docs/content/actions/package.md @@ -0,0 +1,3 @@ ++++ +title = "package" ++++ diff --git a/docs/content/blog/_index.md b/docs/content/blog/_index.md new file mode 100644 index 0000000..ca5be15 --- /dev/null +++ b/docs/content/blog/_index.md @@ -0,0 +1,6 @@ ++++ +title = "List of blog posts" +sort_by = "date" +template = "blog.html" +page_template = "blog-page.html" ++++ \ No newline at end of file diff --git a/docs/content/blog/first.md b/docs/content/blog/first.md new file mode 100644 index 0000000..e704c30 --- /dev/null +++ b/docs/content/blog/first.md @@ -0,0 +1,37 @@ ++++ +title = "My first post" +date = 2019-11-27 ++++ + +# file module + +file + +### Description + +Manage files/folders and their properties + +### Params + +This is my first blog post. + +Another line + +**test**: this is a feature + +### Open Source and Open Standard + +The `Lapdev` core code is open sourced under the AGPL V3 license, with selected features gated under an Enterprise License. + +Before Lapdev, we developed two other open source projects: a code editor Lapce and a native UI toolkit Floem. +Developer environment management software is a crucial component for enhancing developer velocities. +We would not have opted for proprietary software for this purpose ourselves, so it is only logical for us to open source the core code of Lapdev. + +To sustain the development of our open source projects, we've introduced enterprise licensing for certain features. +This enables us to generate revenue that directly supports the ongoing enhancement of Lapdev and our broader open source initiatives. + +Beyond open source, we also favour open standards. +We’ve adopted the devcontainer specification for the definition and configuration of the development environment. +The standard is already supported by popular tools like VSCode, Codespaces and Devpod. +We believe it’s beneficial for developers to have a single format to define their development environment as code, +and to be able to use it across different tools. \ No newline at end of file diff --git a/docs/static/styles/styles.css b/docs/static/styles/styles.css new file mode 100644 index 0000000..ea8f75f --- /dev/null +++ b/docs/static/styles/styles.css @@ -0,0 +1,649 @@ +/* +! tailwindcss v3.4.3 | MIT License | https://tailwindcss.com +*/ + +/* +1. Prevent padding and border from affecting element width. (https://github.com/mozdevs/cssremedy/issues/4) +2. Allow adding a border to an element by just adding a border-width. (https://github.com/tailwindcss/tailwindcss/pull/116) +*/ + +*, +::before, +::after { + box-sizing: border-box; + /* 1 */ + border-width: 0; + /* 2 */ + border-style: solid; + /* 2 */ + border-color: #e5e7eb; + /* 2 */ +} + +::before, +::after { + --tw-content: ''; +} + +/* +1. Use a consistent sensible line-height in all browsers. +2. Prevent adjustments of font size after orientation changes in iOS. +3. Use a more readable tab size. +4. Use the user's configured `sans` font-family by default. +5. Use the user's configured `sans` font-feature-settings by default. +6. Use the user's configured `sans` font-variation-settings by default. +7. Disable tap highlights on iOS +*/ + +html, +:host { + line-height: 1.5; + /* 1 */ + -webkit-text-size-adjust: 100%; + /* 2 */ + -moz-tab-size: 4; + /* 3 */ + -o-tab-size: 4; + tab-size: 4; + /* 3 */ + font-family: "Inter", sans-serif; + /* 4 */ + font-feature-settings: normal; + /* 5 */ + font-variation-settings: normal; + /* 6 */ + -webkit-tap-highlight-color: transparent; + /* 7 */ +} + +/* +1. Remove the margin in all browsers. +2. Inherit line-height from `html` so users can set them as a class directly on the `html` element. +*/ + +body { + margin: 0; + /* 1 */ + line-height: inherit; + /* 2 */ +} + +/* +1. Add the correct height in Firefox. +2. Correct the inheritance of border color in Firefox. (https://bugzilla.mozilla.org/show_bug.cgi?id=190655) +3. Ensure horizontal rules are visible by default. +*/ + +hr { + height: 0; + /* 1 */ + color: inherit; + /* 2 */ + border-top-width: 1px; + /* 3 */ +} + +/* +Add the correct text decoration in Chrome, Edge, and Safari. +*/ + +abbr:where([title]) { + -webkit-text-decoration: underline dotted; + text-decoration: underline dotted; +} + +/* +Remove the default font size and weight for headings. +*/ + +h1, +h2, +h3, +h4, +h5, +h6 { + font-size: inherit; + font-weight: inherit; +} + +/* +Reset links to optimize for opt-in styling instead of opt-out. +*/ + +a { + color: inherit; + text-decoration: inherit; +} + +/* +Add the correct font weight in Edge and Safari. +*/ + +b, +strong { + font-weight: bolder; +} + +/* +1. Use the user's configured `mono` font-family by default. +2. Use the user's configured `mono` font-feature-settings by default. +3. Use the user's configured `mono` font-variation-settings by default. +4. Correct the odd `em` font sizing in all browsers. +*/ + +code, +kbd, +samp, +pre { + font-family: ui-monospace, SFMono-Regular, Menlo, Monaco, Consolas, "Liberation Mono", "Courier New", monospace; + /* 1 */ + font-feature-settings: normal; + /* 2 */ + font-variation-settings: normal; + /* 3 */ + font-size: 1em; + /* 4 */ +} + +/* +Add the correct font size in all browsers. +*/ + +small { + font-size: 80%; +} + +/* +Prevent `sub` and `sup` elements from affecting the line height in all browsers. +*/ + +sub, +sup { + font-size: 75%; + line-height: 0; + position: relative; + vertical-align: baseline; +} + +sub { + bottom: -0.25em; +} + +sup { + top: -0.5em; +} + +/* +1. Remove text indentation from table contents in Chrome and Safari. (https://bugs.chromium.org/p/chromium/issues/detail?id=999088, https://bugs.webkit.org/show_bug.cgi?id=201297) +2. Correct table border color inheritance in all Chrome and Safari. (https://bugs.chromium.org/p/chromium/issues/detail?id=935729, https://bugs.webkit.org/show_bug.cgi?id=195016) +3. Remove gaps between table borders by default. +*/ + +table { + text-indent: 0; + /* 1 */ + border-color: inherit; + /* 2 */ + border-collapse: collapse; + /* 3 */ +} + +/* +1. Change the font styles in all browsers. +2. Remove the margin in Firefox and Safari. +3. Remove default padding in all browsers. +*/ + +button, +input, +optgroup, +select, +textarea { + font-family: inherit; + /* 1 */ + font-feature-settings: inherit; + /* 1 */ + font-variation-settings: inherit; + /* 1 */ + font-size: 100%; + /* 1 */ + font-weight: inherit; + /* 1 */ + line-height: inherit; + /* 1 */ + letter-spacing: inherit; + /* 1 */ + color: inherit; + /* 1 */ + margin: 0; + /* 2 */ + padding: 0; + /* 3 */ +} + +/* +Remove the inheritance of text transform in Edge and Firefox. +*/ + +button, +select { + text-transform: none; +} + +/* +1. Correct the inability to style clickable types in iOS and Safari. +2. Remove default button styles. +*/ + +button, +input:where([type='button']), +input:where([type='reset']), +input:where([type='submit']) { + -webkit-appearance: button; + /* 1 */ + background-color: transparent; + /* 2 */ + background-image: none; + /* 2 */ +} + +/* +Use the modern Firefox focus style for all focusable elements. +*/ + +:-moz-focusring { + outline: auto; +} + +/* +Remove the additional `:invalid` styles in Firefox. (https://github.com/mozilla/gecko-dev/blob/2f9eacd9d3d995c937b4251a5557d95d494c9be1/layout/style/res/forms.css#L728-L737) +*/ + +:-moz-ui-invalid { + box-shadow: none; +} + +/* +Add the correct vertical alignment in Chrome and Firefox. +*/ + +progress { + vertical-align: baseline; +} + +/* +Correct the cursor style of increment and decrement buttons in Safari. +*/ + +::-webkit-inner-spin-button, +::-webkit-outer-spin-button { + height: auto; +} + +/* +1. Correct the odd appearance in Chrome and Safari. +2. Correct the outline style in Safari. +*/ + +[type='search'] { + -webkit-appearance: textfield; + /* 1 */ + outline-offset: -2px; + /* 2 */ +} + +/* +Remove the inner padding in Chrome and Safari on macOS. +*/ + +::-webkit-search-decoration { + -webkit-appearance: none; +} + +/* +1. Correct the inability to style clickable types in iOS and Safari. +2. Change font properties to `inherit` in Safari. +*/ + +::-webkit-file-upload-button { + -webkit-appearance: button; + /* 1 */ + font: inherit; + /* 2 */ +} + +/* +Add the correct display in Chrome and Safari. +*/ + +summary { + display: list-item; +} + +/* +Removes the default spacing and border for appropriate elements. +*/ + +blockquote, +dl, +dd, +h1, +h2, +h3, +h4, +h5, +h6, +hr, +figure, +p, +pre { + margin: 0; +} + +fieldset { + margin: 0; + padding: 0; +} + +legend { + padding: 0; +} + +ol, +ul, +menu { + list-style: none; + margin: 0; + padding: 0; +} + +/* +Reset default styling for dialogs. +*/ + +dialog { + padding: 0; +} + +/* +Prevent resizing textareas horizontally by default. +*/ + +textarea { + resize: vertical; +} + +/* +1. Reset the default placeholder opacity in Firefox. (https://github.com/tailwindlabs/tailwindcss/issues/3300) +2. Set the default placeholder color to the user's configured gray 400 color. +*/ + +input::-moz-placeholder, textarea::-moz-placeholder { + opacity: 1; + /* 1 */ + color: #9ca3af; + /* 2 */ +} + +input::placeholder, +textarea::placeholder { + opacity: 1; + /* 1 */ + color: #9ca3af; + /* 2 */ +} + +/* +Set the default cursor for buttons. +*/ + +button, +[role="button"] { + cursor: pointer; +} + +/* +Make sure disabled buttons don't get the pointer cursor. +*/ + +:disabled { + cursor: default; +} + +/* +1. Make replaced elements `display: block` by default. (https://github.com/mozdevs/cssremedy/issues/14) +2. Add `vertical-align: middle` to align replaced elements more sensibly by default. (https://github.com/jensimmons/cssremedy/issues/14#issuecomment-634934210) + This can trigger a poorly considered lint error in some tools but is included by design. +*/ + +img, +svg, +video, +canvas, +audio, +iframe, +embed, +object { + display: block; + /* 1 */ + vertical-align: middle; + /* 2 */ +} + +/* +Constrain images and videos to the parent width and preserve their intrinsic aspect ratio. (https://github.com/mozdevs/cssremedy/issues/14) +*/ + +img, +video { + max-width: 100%; + height: auto; +} + +/* Make elements with the HTML hidden attribute stay hidden by default */ + +[hidden] { + display: none; +} + +*, ::before, ::after { + --tw-border-spacing-x: 0; + --tw-border-spacing-y: 0; + --tw-translate-x: 0; + --tw-translate-y: 0; + --tw-rotate: 0; + --tw-skew-x: 0; + --tw-skew-y: 0; + --tw-scale-x: 1; + --tw-scale-y: 1; + --tw-pan-x: ; + --tw-pan-y: ; + --tw-pinch-zoom: ; + --tw-scroll-snap-strictness: proximity; + --tw-gradient-from-position: ; + --tw-gradient-via-position: ; + --tw-gradient-to-position: ; + --tw-ordinal: ; + --tw-slashed-zero: ; + --tw-numeric-figure: ; + --tw-numeric-spacing: ; + --tw-numeric-fraction: ; + --tw-ring-inset: ; + --tw-ring-offset-width: 0px; + --tw-ring-offset-color: #fff; + --tw-ring-color: rgb(59 130 246 / 0.5); + --tw-ring-offset-shadow: 0 0 #0000; + --tw-ring-shadow: 0 0 #0000; + --tw-shadow: 0 0 #0000; + --tw-shadow-colored: 0 0 #0000; + --tw-blur: ; + --tw-brightness: ; + --tw-contrast: ; + --tw-grayscale: ; + --tw-hue-rotate: ; + --tw-invert: ; + --tw-saturate: ; + --tw-sepia: ; + --tw-drop-shadow: ; + --tw-backdrop-blur: ; + --tw-backdrop-brightness: ; + --tw-backdrop-contrast: ; + --tw-backdrop-grayscale: ; + --tw-backdrop-hue-rotate: ; + --tw-backdrop-invert: ; + --tw-backdrop-opacity: ; + --tw-backdrop-saturate: ; + --tw-backdrop-sepia: ; + --tw-contain-size: ; + --tw-contain-layout: ; + --tw-contain-paint: ; + --tw-contain-style: ; +} + +::backdrop { + --tw-border-spacing-x: 0; + --tw-border-spacing-y: 0; + --tw-translate-x: 0; + --tw-translate-y: 0; + --tw-rotate: 0; + --tw-skew-x: 0; + --tw-skew-y: 0; + --tw-scale-x: 1; + --tw-scale-y: 1; + --tw-pan-x: ; + --tw-pan-y: ; + --tw-pinch-zoom: ; + --tw-scroll-snap-strictness: proximity; + --tw-gradient-from-position: ; + --tw-gradient-via-position: ; + --tw-gradient-to-position: ; + --tw-ordinal: ; + --tw-slashed-zero: ; + --tw-numeric-figure: ; + --tw-numeric-spacing: ; + --tw-numeric-fraction: ; + --tw-ring-inset: ; + --tw-ring-offset-width: 0px; + --tw-ring-offset-color: #fff; + --tw-ring-color: rgb(59 130 246 / 0.5); + --tw-ring-offset-shadow: 0 0 #0000; + --tw-ring-shadow: 0 0 #0000; + --tw-shadow: 0 0 #0000; + --tw-shadow-colored: 0 0 #0000; + --tw-blur: ; + --tw-brightness: ; + --tw-contrast: ; + --tw-grayscale: ; + --tw-hue-rotate: ; + --tw-invert: ; + --tw-saturate: ; + --tw-sepia: ; + --tw-drop-shadow: ; + --tw-backdrop-blur: ; + --tw-backdrop-brightness: ; + --tw-backdrop-contrast: ; + --tw-backdrop-grayscale: ; + --tw-backdrop-hue-rotate: ; + --tw-backdrop-invert: ; + --tw-backdrop-opacity: ; + --tw-backdrop-saturate: ; + --tw-backdrop-sepia: ; + --tw-contain-size: ; + --tw-contain-layout: ; + --tw-contain-paint: ; + --tw-contain-style: ; +} + +.container { + width: 100%; +} + +@media (min-width: 640px) { + .container { + max-width: 640px; + } +} + +@media (min-width: 768px) { + .container { + max-width: 768px; + } +} + +@media (min-width: 1024px) { + .container { + max-width: 1024px; + } +} + +@media (min-width: 1280px) { + .container { + max-width: 1280px; + } +} + +@media (min-width: 1536px) { + .container { + max-width: 1536px; + } +} + +.markdown-content { +} + +.markdown-content h1 { + margin-left: auto; + margin-right: auto; + margin-bottom: 1.5rem; + max-width: 48rem; + font-size: 2.25rem; + line-height: 2.5rem; + font-weight: 700; +} + +.markdown-content h3 { + margin-left: auto; + margin-right: auto; + margin-top: 1.25rem; + width: 100%; + max-width: 48rem; + font-size: 1.5rem; + line-height: 2rem; + font-weight: 600; +} + +.markdown-content p { + margin-left: auto; + margin-right: auto; + margin-top: 1.25rem; + width: 100%; + max-width: 48rem; +} + +.markdown-content code { + border-radius: 0.25rem; + --tw-bg-opacity: 1; + background-color: rgb(229 231 235 / var(--tw-bg-opacity)); + padding-left: 0.375rem; + padding-right: 0.375rem; +} + +.markdown-content a { + --tw-text-opacity: 1; + color: rgb(236 72 153 / var(--tw-text-opacity)); +} + +.markdown-content a:hover { + --tw-text-opacity: 1; + color: rgb(244 114 182 / var(--tw-text-opacity)); + text-decoration-line: underline; +} + +.mx-auto { + margin-left: auto; + margin-right: auto; +} + +.block { + display: block; +} \ No newline at end of file diff --git a/docs/styles/styles.css b/docs/styles/styles.css new file mode 100644 index 0000000..fc0c5d0 --- /dev/null +++ b/docs/styles/styles.css @@ -0,0 +1,32 @@ +@tailwind base; +@tailwind components; +@tailwind utilities; + +@layer components { + .markdown-content { + } + + .markdown-content h1 { + @apply text-4xl font-bold max-w-3xl mx-auto mb-6; + } + + .markdown-content h3 { + @apply text-2xl font-semibold max-w-3xl w-full mx-auto mt-5; + } + + .markdown-content p { + @apply max-w-3xl w-full mx-auto mt-5; + } + + .markdown-content code { + @apply bg-gray-200 px-1.5 rounded; + } + + .markdown-content a { + @apply text-pink-500; + } + + .markdown-content a:hover { + @apply text-pink-400 underline; + } +} \ No newline at end of file diff --git a/docs/tailwind.config.js b/docs/tailwind.config.js new file mode 100644 index 0000000..25a44f8 --- /dev/null +++ b/docs/tailwind.config.js @@ -0,0 +1,16 @@ +module.exports = { + purge: ["./templates/**/*.html", "./theme/**/*.html"], + theme: { + fontFamily: { + body: '"Inter", sans-serif', + heading: '"Inter", sans-serif', + sans: '"Inter", sans-serif', + serif: '"Inter", sans-serif', + mono: 'ui-monospace, SFMono-Regular, Menlo, Monaco, Consolas, "Liberation Mono", "Courier New", monospace', + }, + }, + variants: {}, + plugins: [ + require('@tailwindcss/typography'), + ], +}; \ No newline at end of file diff --git a/docs/templates/actions-item.html b/docs/templates/actions-item.html new file mode 100644 index 0000000..c2ebb0a --- /dev/null +++ b/docs/templates/actions-item.html @@ -0,0 +1,10 @@ +{% extends "base.html" %} + +{% block content %} +

+ {{ page.title }} +

+
+ {{ page.content | safe }} +
+{% endblock content %} \ No newline at end of file diff --git a/docs/templates/actions.html b/docs/templates/actions.html new file mode 100644 index 0000000..05d2a4e --- /dev/null +++ b/docs/templates/actions.html @@ -0,0 +1,9 @@ +{% extends "base.html" %} + +{% block content %} + +{% endblock content %} \ No newline at end of file diff --git a/docs/templates/base.html b/docs/templates/base.html new file mode 100644 index 0000000..fd3926f --- /dev/null +++ b/docs/templates/base.html @@ -0,0 +1,21 @@ + + + + + + MyBlog + + + + + + + +
+
+ {% block content %} {% endblock %} +
+
+ + + \ No newline at end of file diff --git a/docs/templates/blog-page.html b/docs/templates/blog-page.html new file mode 100644 index 0000000..d121a96 --- /dev/null +++ b/docs/templates/blog-page.html @@ -0,0 +1,11 @@ +{% extends "base.html" %} + +{% block content %} +

+ {{ page.title }} +

+

{{ page.date }}

+
+ {{ page.content | safe }} +
+{% endblock content %} \ No newline at end of file diff --git a/docs/templates/blog.html b/docs/templates/blog.html new file mode 100644 index 0000000..1f931bb --- /dev/null +++ b/docs/templates/blog.html @@ -0,0 +1,13 @@ +{% extends "base.html" %} + +{% block content %} +

+ {{ section.title }} +

+ +{% endblock content %} \ No newline at end of file