https://github.com/prose-im/prose-docs

Prose server docs. Used by Prose server administrators.
https://github.com/prose-im/prose-docs

documentation

Last synced: about 1 month ago
JSON representation

Prose server docs. Used by Prose server administrators.

• Host: GitHub
• URL: https://github.com/prose-im/prose-docs
• Owner: prose-im
• License: mpl-2.0
• Created: 2022-03-29T09:41:32.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2024-08-28T16:57:40.000Z (4 months ago)
• Last Synced: 2024-08-29T17:38:47.776Z (4 months ago)
• Topics: documentation
• Language: Shell
• Homepage: https://docs.prose.org
• Size: 1.07 MB
• Stars: 0
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# prose-docs

[![Build and Deploy](https://github.com/prose-im/prose-docs/actions/workflows/deploy.yml/badge.svg?branch=production)](https://github.com/prose-im/prose-docs/actions/workflows/deploy.yml)

**Prose Technical Docs, used by Prose server administrators.**

Copyright 2022, Prose Foundation - Released under the [Mozilla Public License 2.0](./LICENSE.md).

_Tested at NodeJS version: `v20.5.0`_

## Clone Instructions

As this project uses Git LFS to store large files (ie. PNG, JPG and GIF files from guides), it requires Git LFS to be available on the system cloning this repository.

**1. Start with installing Git LFS using Homebrew:**

`brew install git-lfs`

**2. Then, initialize your Git LFS user configuration:**

`git lfs install`

**3. Finally, clone the repository:**

`git clone [email protected]:prose-im/prose-docs.git`

_⚠️ Make sure that the "filtering" step pulling LFS data is executed (10MB+). This step comes after the "objects" pull step._

## Build Setup

Built with [Chappe](https://github.com/crisp-oss/chappe). See the commands below for reference on how to build the docs.

```bash

# install dependencies

$ npm install

# build static assets for production

$ npm run build

```

## License

Licensing information can be found in the [LICENSE.md](./LICENSE.md) document.