Skip to content

Nas84/Blog

 
 

Repository files navigation

Sogilis Blog

Welcome to the open source Blog of Sogilis !

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

You will need to install the following software:

  • Docker >= 1.38 (18.06.1-ce)
  • node >= 10.13.0 (chose a LTS version for production)
  • yarn (non mandatory, it is either npm or yarn)
  • Git
  • make

Install

A step by step procedure that indicates how to get a development env running First fork this project

git clone --recursive [email protected]:sogilis/Blog.git
cd Blog
make build-image

How to write a new article ?

  1. Start blog locally:
make start-image
make run-debug-server
  1. Write your article:

    Create a new text file in blog_sogilis/content/posts. Following formats are supported:

  2. See the result at http://localhost:1313

  3. Finalize your article, and see the output in real time.

  4. When finished, create a new Pull Request to get feedbacks from other team members.

  5. See the deployemet done in your PR to assess generated static site

  6. Ask a maintener to Merge the Pull Request

How to stop blog locally?

make stop-image
make remove-image

Built With

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

  • Antoine - Initial work - Agervail
  • Jean-batiste - Contributors - Jidibus
  • Nasser - Initial work - Nas84

Releases

No releases published

Packages

No packages published

Languages

  • CSS 74.8%
  • HTML 14.8%
  • JavaScript 9.8%
  • Other 0.6%