forked from SAtacker/quick-ftxui
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Changed README from the given template by Doks
Signed-off-by: Vedant <[email protected]>
- Loading branch information
Showing
3 changed files
with
17 additions
and
13,617 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
Oops, something went wrong.