Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mybb/docs.mybb.com

The MyBB documentation.
https://github.com/mybb/docs.mybb.com

Last synced: 25 days ago
JSON representation

The MyBB documentation.

Host: GitHub
URL: https://github.com/mybb/docs.mybb.com
Owner: mybb
Created: 2013-04-23T00:09:55.000Z (almost 12 years ago)
Default Branch: gh-pages
Last Pushed: 2024-07-04T12:57:27.000Z (7 months ago)
Last Synced: 2024-10-30T00:54:45.238Z (3 months ago)
Language: HTML
Homepage: https://docs.mybb.com
Size: 55.6 MB
Stars: 26
Watchers: 31
Forks: 75
Open Issues: 16
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md

Awesome Lists containing this project

README

        # docs.mybb.com [![Uptime Robot status](https://img.shields.io/uptimerobot/status/m779165696-4574b5c91e22cbf3b9dfbcd7.svg) ![Uptime Robot ratio (30 days)](https://img.shields.io/uptimerobot/ratio/m779165696-4574b5c91e22cbf3b9dfbcd7.svg)](https://stats.uptimerobot.com/W7xgYf0vg) [![Mozilla HTTP Observatory Grade](https://img.shields.io/mozilla-observatory/grade-score/docs.mybb.com.svg)](https://observatory.mozilla.org/analyze/docs.mybb.com) ![Chromium HSTS preload](https://img.shields.io/hsts/preload/docs.mybb.com.svg)

The source of the [**Docs.MyBB.com**](https://docs.mybb.com) website.

Hosted on [GitHub Pages](https://pages.github.com/) using the [Jekyll](https://jekyllrb.com/) server, [Markdown](https://daringfireball.net/projects/markdown/) formatting, [Liquid](https://shopify.github.io/liquid/) templates, and YAML data format.

Some assets are pulled from the [`mybb-website-theme`](https://github.com/mybb/mybb-website-theme/).

## Development

Download the repository content and use [Docker](https://www.docker.com/get-started) to serve the website from local source. Make sure to allow Docker to access the directory using _File sharing_ and run:

```sh

$ docker run -it --rm -p "4000:4000" -v "${PWD}:/usr/src/app" mybb/jekyll-docker

```

This will create a container from a [customized Jekyll image](https://github.com/mybb/jekyll-docker). The website will be available at `https://127.0.0.1:4000` (your browser will warn you about an unsigned certificate that was just generated).

### Using Local Theme

To additionally preview changes made to [`mybb-website-theme`](https://github.com/mybb/mybb-website-theme/) in a sibling directory `../mybb-website-theme/`), run instead:

```sh

$ docker run -it --rm -p "4000:4000" -v "${PWD}:/usr/src/app" -v "${PWD}/../mybb-website-theme:/usr/src/app/_themes/theme" mybb/jekyll-docker

```

## Contributing

See [CONTRIBUTING.md](/CONTRIBUTING.md).