https://github.com/sleekdb/sleekdb.github.io

SleekDB is a simple NoSQL database implementation using pure PHP that store data in plain JSON files.
https://github.com/sleekdb/sleekdb.github.io

Last synced: 3 days ago
JSON representation

SleekDB is a simple NoSQL database implementation using pure PHP that store data in plain JSON files.

• Host: GitHub
• URL: https://github.com/sleekdb/sleekdb.github.io
• Owner: SleekDB
• License: mit
• Created: 2018-04-13T16:32:21.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2022-10-16T22:28:24.000Z (about 2 years ago)
• Last Synced: 2025-01-04T20:57:57.042Z (6 days ago)
• Language: HTML
• Homepage: https://sleekdb.github.io/
• Size: 1.05 MB
• Stars: 5
• Watchers: 3
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# SleekDB Website

The official website of SleekDB [sleekdb.github.io](https://sleekdb.github.io) is hosted on Github Sites.

![SleekDB Website](./assets/sleekdb.github.io.png "SleekDB Website")

The purpose of this website is to serve the documentation of SleekDB.

## Add or Update Docs

- Go to the [docs](https://github.com/SleekDB/docs) repository and clone it.

- You will find some directories which are named according to their version and they contains some markdown(.md) files. If you are not familiar with markdown text format theres an easy [markdown cheet sheet](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet) for you.

- If you want to update documentation of an existing page then find the markdown file, update the content and then create a pull request.

- If you want to create a new documentation page then

  - Register the file name in the `lists.json` file; Example: [lists.json file of version 1.5](https://github.com/SleekDB/docs/blob/master/1.5.0/lists.json)

  - If you want to add it to the sidebar menu then add this HTML comment at the top of the markdown file:

    ```html

    

    ```

    You can find available icons from [ionicons](https://ionicons.com/v4/).

  - Please try to keep the file name and `url` same!

- Once you are happy with the changes then create a Pull Request!

- Also, join our [Telegram channel](https://t.me/joinchat/HWnK7UL429QGXfs7) for community discussion.