Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: hand crafted docs #59

Merged
merged 6 commits into from
Jan 7, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Manage Algorand nodes from the command line
### Synopsis


<img alt="Terminal Render" src="/docs/nodekit.png" width="65%">
<img alt="Terminal Render" src="/assets/nodekit.png" width="65%">


Manage Algorand nodes from the command line
Expand All @@ -29,17 +29,17 @@ algorun [flags]

### SEE ALSO

* [algorun bootstrap](/docs/algorun_bootstrap.md) - Initialize a fresh node
* [algorun catchup](/docs/algorun_catchup.md) - Manage Fast-Catchup for your node
* [algorun configure](/docs/algorun_configure.md) - Change settings on the system (WIP)
* [algorun debug](/docs/algorun_debug.md) - Display debugging information
* [algorun install](/docs/algorun_install.md) - Install the node daemon
* [algorun start](/docs/algorun_start.md) - Start the node daemon
* [algorun stop](/docs/algorun_stop.md) - Stop the node daemon
* [algorun uninstall](/docs/algorun_uninstall.md) - Uninstall the node daemon
* [algorun upgrade](/docs/algorun_upgrade.md) - Upgrade the node daemon

###### Auto generated by spf13/cobra on 3-Jan-2025
* [algorun bootstrap](/man/algorun_bootstrap.md) - Initialize a fresh node
* [algorun catchup](/man/algorun_catchup.md) - Manage Fast-Catchup for your node
* [algorun configure](/man/algorun_configure.md) - Change settings on the system (WIP)
* [algorun debug](/man/algorun_debug.md) - Display debugging information
* [algorun install](/man/algorun_install.md) - Install the node daemon
* [algorun start](/man/algorun_start.md) - Start the node daemon
* [algorun stop](/man/algorun_stop.md) - Stop the node daemon
* [algorun uninstall](/man/algorun_uninstall.md) - Uninstall the node daemon
* [algorun upgrade](/man/algorun_upgrade.md) - Upgrade the node daemon

###### Auto generated by spf13/cobra on 6-Jan-2025

### Installing

Expand Down
Binary file removed assets/Banner.gif
Binary file not shown.
Binary file removed assets/TUI.png
Binary file not shown.
File renamed without changes.
Binary file added assets/nodekit.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
21 changes: 21 additions & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# build output
dist/
# generated types
.astro/

# dependencies
node_modules/

# logs
npm-debug.log*
yarn-debug.log*
yarn-error.log*
pnpm-debug.log*


# environment variables
.env
.env.production

# macOS-specific files
.DS_Store
55 changes: 55 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
# Starlight Starter Kit: Tailwind

[![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build)

```
npm create astro@latest -- --template starlight/tailwind
```

[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/starlight/tree/main/examples/tailwind)
[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/starlight/tree/main/examples/tailwind)
[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/withastro/starlight&create_from_path=examples/tailwind)
[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fwithastro%2Fstarlight%2Ftree%2Fmain%2Fexamples%2Ftailwind&project-name=my-starlight-docs&repository-name=my-starlight-docs)

> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!

## 🚀 Project Structure

Inside of your Astro + Starlight project, you'll see the following folders and files:

```
.
├── public/
├── src/
│ ├── assets/
│ ├── content/
│ │ ├── docs/
│ └── content.config.ts
├── astro.config.mjs
├── package.json
├── tailwind.config.mjs
└── tsconfig.json
```

Starlight looks for `.md` or `.mdx` files in the `src/content/docs/` directory. Each file is exposed as a route based on its file name.

Images can be added to `src/assets/` and embedded in Markdown with a relative link.

Static assets, like favicons, can be placed in the `public/` directory.

## 🧞 Commands

All commands are run from the root of the project, from a terminal:

| Command | Action |
| :------------------------ | :----------------------------------------------- |
| `npm install` | Installs dependencies |
| `npm run dev` | Starts local dev server at `localhost:4321` |
| `npm run build` | Build your production site to `./dist/` |
| `npm run preview` | Preview your build locally, before deploying |
| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
| `npm run astro -- --help` | Get help using the Astro CLI |

## 👀 Want to learn more?

Check out [Starlight’s docs](https://starlight.astro.build/), read [the Astro documentation](https://docs.astro.build), or jump into the [Astro Discord server](https://astro.build/chat).
36 changes: 36 additions & 0 deletions docs/astro.config.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
// @ts-check
import { defineConfig } from 'astro/config';
import starlight from '@astrojs/starlight';
import tailwind from '@astrojs/tailwind';

// https://astro.build/config
export default defineConfig({
integrations: [
starlight({
title: 'NodeKit',
logo: {
src: './public/nodekit.png',
replacesTitle: true,
},
social: {
github: 'https://github.com/withastro/starlight',
},
sidebar: [
{
label: 'Guides',
items: [
// Each item here is one entry in the navigation menu.
{ label: 'Example Guide', slug: 'guides/example' },
],
},
{
label: 'Reference',
collapsed: true,
autogenerate: { directory: 'reference' },
},
],
customCss: ['./src/tailwind.css'],
}),
tailwind({ applyBaseStyles: true }),
],
});
Binary file removed docs/nodekit.png
Binary file not shown.
Loading
Loading