Skip to content

Latest commit

 

History

History
102 lines (63 loc) · 2.44 KB

README.md

File metadata and controls

102 lines (63 loc) · 2.44 KB

Deployed

The technical blog of Open FUN powered by Hugo and the blowfish theme.

Getting started

If this is the first time you use this repository you must run the following command:

make bootstrap

Next time you can simply use the command:

make run

to start the Hugo development server.

Once this is done, Hugo is served on http://localhost:1313 🎉.

You are now able to write content! Take a look at the next section to know how to do.

Authoring

Create a new post

To create a new post, run the command :

make post

Then fill the prompt by providing the post title :

What is the title of the new post?
>>>

Once the post created, post content is stored into /content/posts/<your-new-post>/ directory.

Thumbnail

Post images must be located into the same folder than the post itself. To use an image as thumbnail, it must be prefixed by feature-.

Add a new author

Author descriptions are located into data/authors and author images are located into assets/authors.

cd data/authors
cp template.json <author_name>.json

Then fill all fields with your personal information.

Attach an author to a post

Within the post header, you can add an authors attributes. The author name corresponds to the name of the file you created previously.

e.g:

title: "Post title" ... authors:

- "<author_name>"

---

Further information

Let's go further? Have a look at the documentation of blowfish and Hugo.

Contributing

This project is intended to be community-driven, so please, do not hesitate to get in touch if you have any question related to our implementation or design decisions.

We try to raise our code quality standards and expect contributors to follow the recommendations from our handbook.

License

Blog source code

This work is released under the MIT License (see LICENSE).

Posts

This work is released under the CC-BY-SA 4.0 License (see LICENSE).