Skip to content

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

License

Notifications You must be signed in to change notification settings

mrxiaozhuox/karaty

Repository files navigation

Karaty

A powerful blog & docs framework, powered by Dioxus.

Static Badge GitHub Actions Workflow Status GitHub commit activity GitHub Downloads (all assets, all releases) GitHub repo size

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 UI framework.
  • Support Dark Mode and compatible Mobile visitor

Quick Start

Build from Source

Install dioxus-cli

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

Clone project from Github

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

Start Development server

dx serve

Startup with compiled file

You can download karaty.zip 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.