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

https://github.com/swoft-cloud/swoft-www

Swoft www
https://github.com/swoft-cloud/swoft-www

Last synced: 3 months ago
JSON representation

Swoft www

Awesome Lists containing this project

README

          

# Swoft Framework

[中文](https://github.com/swoft-cloud/swoft-www-cn) | English

The site is built on [huog](https://gohugo.io) and developed based on the [Academic Kickstart](https://sourcethemes.com/academic/) theme, the content of the document is in the `content/documents/` folder. Inside, the format is `Markdown`.

## Development

You need to understand the basics of [huog](https://gohugo.io) and master the [Academic Kickstart](https://sourcethemes.com/academic/) template.

```bash
# Cloning project
$ git clone https://github.com/swoft-cloud/swoft-doc.git
# Switch directory
$ cd swoft-doc
# Download Hugo's theme
$ git submodule update --init --recursive
#Start local service
$ hugo server
```

## Deploy

This site uses [netlify](https://netlify.com) to automate continuous integration of the `master` branch.

## How to participate in the contribution

Currently the website is in development and everyone is welcome:

* Participate in website style development
* Participate in the preparation of document content
* Fix typos or wrong writing format
* Issue issue Discussion translation or writing format
* Issue an issue to discuss related suggestions or questions
* Participate in the translation of English documents.

note:

In principle, only the construction of the official website of the document is carried out here. It is not suitable for discussing the related issues of Swoft. It is recommended that the relevant issues be discussed in the related warehouses, chat rooms or major technical communities in Sofft so as to get more help and more people. discussion.