Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mrxiaozhuox/karaty

A static personal profile website made by Dioxus. use GitHub manage your page & post
https://github.com/mrxiaozhuox/karaty

blog dioxus docs-generator giscus github rust static-site-generator tailwindcss wasm

Last synced: about 1 month ago
JSON representation

A static personal profile website made by Dioxus. use GitHub manage your page & post

Host: GitHub
URL: https://github.com/mrxiaozhuox/karaty
Owner: mrxiaozhuox
License: mit
Created: 2023-03-08T18:58:45.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2024-09-07T07:17:57.000Z (2 months ago)
Last Synced: 2024-09-27T12:23:03.177Z (about 2 months ago)
Topics: blog, dioxus, docs-generator, giscus, github, rust, static-site-generator, tailwindcss, wasm
Language: Rust
Homepage: https://karaty.mrxzx.info/
Size: 51 MB
Stars: 27
Watchers: 1
Forks: 0
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        
# Karaty

> A powerful blog & docs framework, powered by [Dioxus][dioxus].

[![Static Badge](https://img.shields.io/badge/dioxus-0.4.3-green?logo=Rust)](https://github.com/DioxusLabs/dioxus/releases/tag/v0.4.3) [![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/mrxiaozhuox/karaty/main.yml?logo=GitHub)](https://github.com/mrxiaozhuox/karaty/actions) [![GitHub commit activity](https://img.shields.io/github/commit-activity/y/mrxiaozhuox/karaty?logo=Git)](https://github.com/mrxiaozhuox/karaty/commits/main/) [![GitHub Downloads (all assets, all releases)](https://img.shields.io/github/downloads/mrxiaozhuox/karaty/total?logo=superuser)](https://github.com/mrxiaozhuox/karaty/releases) [![GitHub repo size](https://img.shields.io/github/repo-size/mrxiaozhuox/karaty?logo=Git)](#)

## Features

- Powered by single `.wasm` file.

- Display markdown content without compile & build.

- Use single config file `karaty.toml` to setup website.

- Easy to deploy to **Github Pages** and **Static File Server**.

- Support custom template by [Dioxus][dioxus] UI framework.

- Support Dark Mode and compatible Mobile visitor

## Quick Start

### Build from Source

Install **dioxus-cli**

```shell

cargo install dioxus-cli --git https://github.com/mrxiaozhuox/dioxus-cli

```

Clone project from Github

```shell

git clone https://github.com/mrxiaozhuox/karaty --branch new

```

Start Development server

```shell

dx serve

```

### Startup with compiled file

You can download [karaty.zip](https://github.com/mrxiaozhuox/karaty/releases) file in Release list.

#### Deploy by web server

- Download **Karaty** compiled package.

- Deploy a web server which support dynamic route.

- Config your website in `karaty.toml` file.

#### Deploy by GitHub pages

- Create a new repository.

- Copy `index.html` to `404.html` in root path.

- Push compiled package.

- Open GitHub pags in repository and bind domain.

## Contribute

You should make change at `karaty` directory.

[dioxus]: https://dioxuslabs.com/	"DioxusLabs"