Skip to content

Commit

Permalink
Change home page. Move stuff around. Fix README.
Browse files Browse the repository at this point in the history
  • Loading branch information
wasabii committed Sep 18, 2023
1 parent 5a577ae commit ebea4a8
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 59 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/ikvm-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,15 +26,15 @@ jobs:
run: npm install
- name: Generate
run: npm run generate
- name: Upload Pages artifact
- name: Upload Pages
uses: actions/upload-pages-artifact@v2
with:
path: .output/public
deploy:
name: Deploy
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2

58 changes: 2 additions & 56 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,57 +1,3 @@
# Docus Starter
# IKVM Documentation Site

Starter template for [Docus](https://docus.dev).

## Clone

Clone the repository (using `nuxi`):

```bash
npx nuxi init -t themes/docus
```

## Setup

Install dependencies:

```bash
yarn install
```

## Development

```bash
yarn dev
```

## Edge Side Rendering

Can be deployed to Vercel Functions, Netlify Functions, AWS, and most Node-compatible environments.

Look at all the available presets [here](https://v3.nuxtjs.org/guide/deploy/presets).

```bash
yarn build
```

## Static Generation

Use the `generate` command to build your application.

The HTML files will be generated in the .output/public directory and ready to be deployed to any static compatible hosting.

```bash
yarn generate
```

## Preview build

You might want to preview the result of your build locally, to do so, run the following command:

```bash
yarn preview
```

---

For a detailed explanation of how things work, check out [Docus](https://docus.dev).
Built with docus. Will export documentation from external IKVM release artifacts.
2 changes: 1 addition & 1 deletion content/0.index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ main:
---
cta:
- Documentation
- /introduction/getting-started
- /usage/install
secondary:
- Open on GitHub →
- https://github.com/ikvmnet/ikvm
Expand Down
File renamed without changes.

0 comments on commit ebea4a8

Please sign in to comment.