diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..e69de29 diff --git a/content/docs/_index.md b/content/docs/_index.md index 0ebf088..95d95cc 100644 --- a/content/docs/_index.md +++ b/content/docs/_index.md @@ -1,5 +1,36 @@ -+++ -title = 'Docs' -date = 2025-01-20T14:07:33+01:00 -draft = true -+++ +--- +linkTitle: "Documentation" +title: Introduction +--- + +👋 Hello! Welcome to the Forkey documentation! + + + +## What is Forkey? + +Forkey is a Misskey.io fork that adds many fixes, features, and fun stuff. + +## Features + +- **Customize Emails** - As an admin you can fully customize how sent emails look. +- **Accessibility Features** - Features such as being able to turn off cat speak locally, alt text reminders, and more. +- **Drive Search** - Search your drive based on alt text +- **Mastodon API Support** - Mastodon API support is coming soon. +- **Firefish & Sharkey Features** - Many Firefish and Sharkey features have been cherrypicked to help make people feel at home and like they arent missing features. +- **Much more to come** - Forkey is quite a new fork. Many more features are planned to come soon. + +## Questions or Feedback? + +{{< callout emoji="❓" >}} + Forkey is still in active development. + Have a question or feedback? Feel free to [open an issue](https://git.woem.men/woem.men/forkey/issues)! +{{< /callout >}} + +## Next + +Dive right into the following section to get started: + +{{< cards >}} + {{< card link="getting-started" title="Getting Started" icon="document-text" subtitle="Learn how to install Forkey" >}} +{{< /cards >}} \ No newline at end of file diff --git a/content/docs/getting-started/index.md b/content/docs/getting-started/index.md new file mode 100644 index 0000000..4504d29 --- /dev/null +++ b/content/docs/getting-started/index.md @@ -0,0 +1,24 @@ +--- +title: Getting Started +weight: 1 +next: /docs/guide +prev: /docs +--- + +## Using Docker + +TODO + +## Building from source + +TODO - For now just follow the misskey tutorial to set up forkey + +## Next + +Explore the following sections to start adding more contents: + +{{< cards >}} + {{< card link="../guide/organize-files" title="Organize Files" icon="document-duplicate" >}} + {{< card link="../guide/configuration" title="Configuration" icon="adjustments" >}} + {{< card link="../guide/markdown" title="Markdown" icon="markdown" >}} +{{< /cards >}} diff --git a/content/docs/guide/_index.md b/content/docs/guide/_index.md new file mode 100644 index 0000000..0e37ef1 --- /dev/null +++ b/content/docs/guide/_index.md @@ -0,0 +1,24 @@ +--- +title: Guide +weight: 2 +prev: /docs/getting-started +next: /docs/guide/organize-files +sidebar: + open: true +--- + +Explore the following sections to learn how to use and set up Forkey: + + + +{{< cards >}} + {{< card link="custom-email" title="Customize Email" icon="at-symbol" >}} + +{{< /cards >}} \ No newline at end of file diff --git a/content/docs/guide/custom-email/index.md b/content/docs/guide/custom-email/index.md new file mode 100644 index 0000000..78cc258 --- /dev/null +++ b/content/docs/guide/custom-email/index.md @@ -0,0 +1,130 @@ +--- +title: Custom Email +weight: 1 +next: /docs/guide +prev: /docs +--- + +## Setting a custom email template + +### Locating the setting +A custom email template can be set under the control panel in Email server. At the bottom of everything you will see a dropdown to set a custom email template. This template will be used for any emails from the instance like signups and other things. + +### How to edit it +Edit the HTML in the textbox and dont forget to hit save and to test is because email does not support the full html standard. At the bottom of this textbox is a link to see what tags email supports. Also make sure you include the `{{ subject }}` and `{{ html }}` tags somewhere in there otherwise emails wont work properly. + +{{% details title="The default email template" closed="true" %}} + +If you deleted the default template and want it back here it is: + +```html + + + + + {{ subject }} + + + +
+
+ The instances logo +
+
+

{{ subject }}

+
{{ html }}
+
+ +
+ + + +``` + +{{% /details %}} + +### Handlebar Keys + +Keys are things that need to be inserted into your template to make it work properly such as `{{ logo }}` or `{{ html }}` +Here each key and its use will be outlined. + +| subject | The subject or title of the email | +|-----------------|----------------------------------------------------------------| +| html | The body that will be inserted in the email. This is required. | +| logo | The url to your instances logo | +| emailSettingUrl | The url for the user to change their email settings | +| url | The url of your instance | +| host | The host of your instance | diff --git a/content/docs/test/index.md b/content/docs/test/index.md deleted file mode 100644 index 4c12975..0000000 --- a/content/docs/test/index.md +++ /dev/null @@ -1,192 +0,0 @@ ---- -title: Getting Started -weight: 1 -next: /docs/guide -prev: /docs ---- - -## Quick Start from Template - -{{< icon "github" >}} [imfing/hextra-starter-template](https://github.com/imfing/hextra-starter-template) - -You could quickly get started by using the above template repository. - - - -We have provided a [GitHub Actions workflow](https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site#publishing-with-a-custom-github-actions-workflow) which can help automatically build and deploy your site to GitHub Pages, and host it for free. -For more options, check out [Deploy Site](../guide/deploy-site). - -[🌐 Demo ↗](https://imfing.github.io/hextra-starter-template/) - -## Start as New Project - -There are two main ways to add the Hextra theme to your Hugo project: - -1. **Hugo Modules (Recommended)**: The simplest and recommended method. [Hugo modules](https://gohugo.io/hugo-modules/) let you pull in the theme directly from its online source. Theme is downloaded automatically and managed by Hugo. - -2. **Git Submodule**: Alternatively, add Hextra as a [Git Submodule](https://git-scm.com/book/en/v2/Git-Tools-Submodules). The theme is downloaded by Git and stored in your project's `themes` folder. - -### Setup Hextra as Hugo module - -#### Prerequisites - -Before starting, you need to have the following software installed: - -- [Hugo (extended version)](https://gohugo.io/installation/) -- [Git](https://git-scm.com/) -- [Go](https://go.dev/) - -#### Steps - -{{% steps %}} - -### Initialize a new Hugo site - -```shell -hugo new site my-site --format=yaml -``` - -### Configure Hextra theme via module - -```shell -# initialize hugo module -cd my-site -hugo mod init github.com/username/my-site - -# add Hextra theme -hugo mod get github.com/imfing/hextra -``` - -Configure `hugo.yaml` to use Hextra theme by adding the following: - -```yaml -module: - imports: - - path: github.com/imfing/hextra -``` - -### Create your first content pages - -Create new content page for the home page and the documentation page: - -```shell -hugo new content/_index.md -hugo new content/docs/_index.md -``` - -### Preview the site locally - -```shell -hugo server --buildDrafts --disableFastRender -``` - -Voila, your new site preview is available at `http://localhost:1313/`. - -{{% /steps %}} - - -{{% details title="How to update theme?" %}} - -To update all Hugo modules in your project to their latest versions, run the following command: - -```shell -hugo mod get -u -``` - -To update Hextra to the [latest released version](https://github.com/imfing/hextra/releases), run the following command: - -```shell -hugo mod get -u github.com/imfing/hextra -``` - -See [Hugo Modules](https://gohugo.io/hugo-modules/use-modules/#update-all-modules) for more details. - -{{% /details %}} - -### Setup Hextra as Git submodule - -#### Prerequisites - -Before starting, you need to have the following software installed: - -- [Hugo (extended version)](https://gohugo.io/installation/) -- [Git](https://git-scm.com/) - -#### Steps - -{{% steps %}} - -### Initialize a new Hugo site - -```shell -hugo new site my-site --format=yaml -``` - -### Add Hextra theme as a Git submodule - -```shell -git submodule add https://github.com/imfing/hextra.git themes/hextra -``` - -Configure `hugo.yaml` to use Hextra theme by adding the following: - -```yaml -theme: hextra -``` - -### Create your first content pages - -Create new content page for the home page and the documentation page: - -```shell -hugo new content/_index.md -hugo new content/docs/_index.md -``` - -### Preview the site locally - -```shell -hugo server --buildDrafts --disableFastRender -``` - -Your new site preview is available at `http://localhost:1313/`. - -{{% /steps %}} - - -When using [CI/CD](https://en.wikipedia.org/wiki/CI/CD) for Hugo website deployment, it's essential to ensure that the following command is executed before running the `hugo` command. - -```shell -git submodule update --init -``` - -Failure to run this command results in the theme folder not being populated with Hextra theme files, leading to a build failure. - - -{{% details title="How to update theme?" %}} - -To update all submodules in your repository to their latest commits, run the following command: - -```shell -git submodule update --remote -``` - -To update Hextra to the latest commit, run the following command: - -```shell -git submodule update --remote themes/hextra -``` - -See [Git submodules](https://git-scm.com/book/en/v2/Git-Tools-Submodules) for more details. - -{{% /details %}} - -## Next - -Explore the following sections to start adding more contents: - -{{< cards >}} - {{< card link="../guide/organize-files" title="Organize Files" icon="document-duplicate" >}} - {{< card link="../guide/configuration" title="Configuration" icon="adjustments" >}} - {{< card link="../guide/markdown" title="Markdown" icon="markdown" >}} -{{< /cards >}} diff --git a/hugo.yaml b/hugo.yaml index b474e8d..308bf8a 100644 --- a/hugo.yaml +++ b/hugo.yaml @@ -78,14 +78,14 @@ menu: weight: 3 params: - description: Modern, responsive, batteries-included Hugo theme for creating beautiful static websites. + description: The forkey documentation site navbar: displayTitle: true displayLogo: true logo: - path: images/logo.svg - dark: images/logo-dark.svg + path: favicon.svg + dark: favicon.svg # width: 40 # height: 20 # link: / diff --git a/i18n/en.yaml b/i18n/en.yaml index 35db7e5..8ef411e 100644 --- a/i18n/en.yaml +++ b/i18n/en.yaml @@ -4,7 +4,7 @@ changeTheme: "Change theme" copyCode: "Copy code" copyright: "© 2025 Forkey Project." dark: "Dark" -editThisPage: "Edit this page on GitHub →" +editThisPage: "Edit this page →" lastUpdated: "Last updated on" light: "Light" noResultsFound: "No results found." diff --git a/public/A bit bigger.svg b/public/A bit bigger.svg new file mode 100644 index 0000000..923519f --- /dev/null +++ b/public/A bit bigger.svg @@ -0,0 +1,66 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/public/images/Frame 4.svg:Zone.Identifier b/public/A bit bigger.svg:Zone.Identifier similarity index 100% rename from public/images/Frame 4.svg:Zone.Identifier rename to public/A bit bigger.svg:Zone.Identifier diff --git a/public/android-chrome-192x192.png b/public/android-chrome-192x192.png index 7f0493c..e359518 100644 Binary files a/public/android-chrome-192x192.png and b/public/android-chrome-192x192.png differ diff --git a/public/android-chrome-512x512.png b/public/android-chrome-512x512.png index faea4c2..efb7ae7 100644 Binary files a/public/android-chrome-512x512.png and b/public/android-chrome-512x512.png differ diff --git a/public/apple-touch-icon.png b/public/apple-touch-icon.png index eb281cb..3d57556 100644 Binary files a/public/apple-touch-icon.png and b/public/apple-touch-icon.png differ diff --git a/public/categories/index.html b/public/categories/index.html index 5de6119..8593850 100644 --- a/public/categories/index.html +++ b/public/categories/index.html @@ -14,15 +14,15 @@ - + - + - + @@ -61,8 +61,8 @@