Skip to content

Commit

Permalink
Changed README from the given template by Doks
Browse files Browse the repository at this point in the history
Signed-off-by: Vedant <[email protected]>
  • Loading branch information
vrnimje committed Sep 29, 2023
1 parent 245971d commit 12ef10c
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 13,617 deletions.
46 changes: 17 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,42 +1,30 @@
# Doks
# Quick-FTXUI Documentation

Doks is a documentation theme for [Hyas](https://gethyas.com/).
This branch is for the documentation website for Quick-FTXUI. We have adopted the `Doks` theme from HUGO.

## Demo
Website: vrnimje.github.io/quick-ftxui/

- [doks.netlify.app](https://doks.netlify.app/)
Some known issues:
1. Search functionality doesn't work in deployed site


## View Locally

## Install

The recommended way to install the latest version of Doks is by running the command below:
To view the website locally, node, npm and HUGO should be installed on your system. Once the dependencies are met, you can then follow these steps

```bash
npm create hyas@latest -- --template doks
```

Looking for help? Start with our [Getting Started](https://getdoks.org/docs/start-here/getting-started/) guide.

## Documentation

Visit our [official documentation](https://getdoks.org/).
# Clone the repository
git clone https://github.com/vrnimje/quick-ftxui.git
cd quick-ftxui
git checkout docs

## Support
# Install dependencies
npm install

Having trouble? Get help in the official [Doks Discussions](https://github.com/h-enk/doks/discussions).
# View the website on the localhost
npm run dev
```

## Contributing

New contributors welcome! Check out our [Contributor Guides](https://getdoks.org/contribute/) for help getting started.

## Links

- [License (MIT)](LICENSE)
- [Code of Conduct](https://github.com/gethyas/.github/blob/main/CODE_OF_CONDUCT.md)
- [Project Funding](.github/FUNDING.md)
- [Website](https://getdoks.org/)

## Sponsors

Doks is supported by Netlify, Algolia, and several other amazing organizations and inidviduals. [Sponsor Doks!](.github/FUNDING.md) ❤️
Everyone is welcome to contribute and fix issues in our website. Just fork this repository, create a branch of `docs`, and then create a pull request for the same.
Loading

0 comments on commit 12ef10c

Please sign in to comment.