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

Cleanup docs #301

Merged
merged 3 commits into from
Mar 15, 2024
Merged
Changes from 1 commit
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
Next Next commit
remove vuepress docs from main repo
Thiht committed Mar 15, 2024

Verified

This commit was signed with the committer’s verified signature.
larskuhtz Lars Kuhtz
commit 449f9766c4eb5a6d2c20e321045a562d14dc6dd6
1 change: 0 additions & 1 deletion .dockerignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
.cache/
.git/
.vscode/
docs/
node_modules/
tests/
1 change: 0 additions & 1 deletion .eslintignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
.parcel-cache/
.vscode/
build/
docs/.vuepress/dist/
node_modules/
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -3,7 +3,6 @@
.vscode/
build/
coverage/
docs/.vuepress/dist/
node_modules/
sessions/
smocker
17 changes: 3 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
<h1 align="center">
<img src="docs/.vuepress/public/logo/logo-horizontal.png" alt="Smocker" height="100" title="Smocker logo by mandyellow" />
<img src="./docs/logo-horizontal.png" alt="Smocker" height="100" title="Smocker logo by mandyellow" />
</h1>

[![CI](https://github.com/Thiht/smocker/actions/workflows/main.yml/badge.svg)](https://github.com/Thiht/smocker/actions/workflows/main.yml)
[![Netlify Status](https://img.shields.io/netlify/61d4e090-b242-419f-8d69-e9dee3d50a37?logo=netlify)](https://app.netlify.com/sites/smocker/deploys)
[![Docker Repository](https://img.shields.io/badge/docker-thiht%2Fsmocker-blue?logo=docker)](https://hub.docker.com/r/thiht/smocker)
[![Github Release](https://img.shields.io/github/v/release/Thiht/smocker.svg?logo=github)](https://github.com/Thiht/smocker/releases/latest)
[![Go Report Card](https://goreportcard.com/badge/github.com/Thiht/smocker)](https://goreportcard.com/report/github.com/Thiht/smocker)
@@ -25,7 +24,6 @@ The documentation is available on [smocker.dev](https://smocker.dev).
- [Development](#development)
- [Backend](#backend)
- [Frontend](#frontend)
- [Documentation](#documentation)
- [Docker](#docker)
- [Caddy](#caddy)
- [HTTPS](#https)
@@ -65,9 +63,9 @@ curl localhost:8081/version

Smocker exposes a configuration user interface. You can access it in your web browser on http://localhost:8081/.

![History](docs/.vuepress/public/screenshots/screenshot-history.png)
![History](docs/screenshots/screenshot-history.png)

![Mocks](docs/.vuepress/public/screenshots/screenshot-mocks.png)
![Mocks](docs/screenshots/screenshot-mocks.png)

## Usage

@@ -160,15 +158,6 @@ The frontend is written with TypeScript and React. You can use the following com
- `yarn test`: execute unit tests
- `yarn test:watch`: execute unit tests, with live reload

### Documentation

The documentation is written in Markdown using [Vuepress](https://vuepress.vuejs.org/). You can use the following commands to manage the documentation:

- `yarn install`: install the dependencies
- `yarn docs:generate`: regenerate documentation screenshots (require the whole application to be started on the default ports)
- `yarn docs:dev`: start the documentation in development mode, with live reload
- `yarn docs:build`: generate the static production documentation

### Docker

The application can be packaged as a standalone Docker image. You can use the following commands to manage the development lifecycle:
128 changes: 0 additions & 128 deletions docs/.vuepress/config.js

This file was deleted.

Binary file removed docs/.vuepress/public/logo/cover.png
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
9 changes: 0 additions & 9 deletions docs/.vuepress/public/logo/favicon/browserconfig.xml

This file was deleted.

Binary file removed docs/.vuepress/public/logo/favicon/favicon-16x16.png
Binary file not shown.
Binary file removed docs/.vuepress/public/logo/favicon/favicon-32x32.png
Binary file not shown.
Binary file removed docs/.vuepress/public/logo/favicon/favicon.ico
Binary file not shown.
Binary file not shown.
1 change: 0 additions & 1 deletion docs/.vuepress/public/logo/favicon/safari-pinned-tab.svg

This file was deleted.

19 changes: 0 additions & 19 deletions docs/.vuepress/public/logo/favicon/site.webmanifest

This file was deleted.

Binary file removed docs/.vuepress/public/logo/logo-h280.png
Binary file not shown.
Binary file removed docs/.vuepress/public/logo/logo-h50.png
Binary file not shown.
Loading