https://github.com/nspcc-dev/doc-fs-neo-org

NeoFS Documentaion site
https://github.com/nspcc-dev/doc-fs-neo-org

Last synced: 4 months ago
JSON representation

NeoFS Documentaion site

• Host: GitHub
• URL: https://github.com/nspcc-dev/doc-fs-neo-org
• Owner: nspcc-dev
• License: other
• Created: 2021-11-26T16:40:24.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-10-12T10:35:30.000Z (over 2 years ago)
• Last Synced: 2024-04-14T22:50:36.281Z (about 2 years ago)
• Language: SCSS
• Size: 3.07 MB
• Stars: 0
• Watchers: 6
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          








  NeoFS Documentation site



---

![License](https://img.shields.io/github/license/nspcc-dev/doc-fs-neo-org.svg?style=popout)

## Overview

Welcome to the NeoFS Documentation site repository!

This is a [NeoSPCC](https://nspcc.io/) maintained and community supported

NeoFS documentation project, where everyone can contribute new articles, suggest

new topics and enhance existing content.

All documentation can be edited via GitHub. We use Hugo for static content

generation, so most of Hugo guides are applicable for this site.

## How to contribute

1. Fork the repo

2. Make some changes

3. Check how it looks localy with `make server`

4. Submit a PR

5. Wait for PR to be merged =)

## Usage

To build and run doc site locally one needs to run `make public`. This `make`

target will download the required version of hugo and use it for site generation.

The resulting static site content will be in the `public` directory.

## License

License: CC BY-NC-SA 4.0


This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.