https://github.com/YOURLS/website

🌐 Website, docs, and blog for YOURLS
https://github.com/YOURLS/website

blog docs documentation docusaurus yourls

Last synced: about 2 months ago
JSON representation

🌐 Website, docs, and blog for YOURLS

• Host: GitHub
• URL: https://github.com/YOURLS/website
• Owner: YOURLS
• License: cc-by-4.0
• Created: 2022-03-06T19:20:51.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-05-27T09:46:18.000Z (4 months ago)
• Last Synced: 2024-05-27T12:32:02.658Z (4 months ago)
• Topics: blog, docs, documentation, docusaurus, yourls
• Language: JavaScript
• Homepage: https://yourls.org
• Size: 2.85 MB
• Stars: 6
• Watchers: 4
• Forks: 66
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

• awesome - YOURLS/website - 🌐 Website, docs, and blog for YOURLS (JavaScript)

README

        
# YOURLS Website

> The sources of the [website](https://yourls.org) for [YOURLS](https://yourls.org)

## Contributing

Site content is written in Markdown format located in:

- [`docs/`](/docs/) for the [documentation](https://yourls.org/docs) ([development guide](https://docusaurus.io/docs/docs-introduction));

- [`blog/`](/blog/) for the [blog](https://yourls.org/blog) ([development guide](https://docusaurus.io/docs/blog));

- [`src/`](/src/) for the [standalone pages](https://yourls.org/) ([development guide](https://docusaurus.io/docs/creating-pages)).

> [!TIP]

> For simple edits, you can directly edit the file on GitHub and generate a Pull Request.

See the [Contributing Guidelines](https://github.com/YOURLS/.github/blob/master/CONTRIBUTING.md)

for our rules and recommendations on contributions.

## Development

### Dev Container

[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://github.com/codespaces/new?hide_repo_select=true&ref=main&repo=466833669)

This repository is ready for [Development Containers](https://containers.dev/).

Click the badge above to create a codespace for this repository and start making and submitting changes.

### Local

This site is built with [Docusaurus 2](https://docusaurus.io/).

See engine guide on supported [Markdown extensions](https://docusaurus.io/docs/markdown-features).

```bash

npm install

npm run start

```

## License

The documentation content is licensed under a [CC BY 4.0 license](LICENSE).

All other code in this repository is licensed under the [MIT license](LICENSE-CODE).