https://github.com/jabolopes/comico

A simple comic blog generator
https://github.com/jabolopes/comico

blog comics golang static-site-generator

Last synced: 17 days ago
JSON representation

A simple comic blog generator

• Host: GitHub
• URL: https://github.com/jabolopes/comico
• Owner: jabolopes
• License: bsd-3-clause
• Created: 2024-12-03T22:18:22.000Z (20 days ago)
• Default Branch: main
• Last Pushed: 2024-12-03T23:15:16.000Z (20 days ago)
• Last Synced: 2024-12-04T00:19:38.158Z (20 days ago)
• Topics: blog, comics, golang, static-site-generator
• Language: Perl
• Homepage:
• Size: 455 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# comico

A simple program to create comic blogs.

![Blog screenshot](https://github.com/user-attachments/assets/a366a6d8-9d18-49e2-8e54-3814c69cba6c)

![Post screenshot](https://github.com/user-attachments/assets/26b899b5-ad94-4fc5-ab8d-7eaab0bdebf8)

Inspired by [bashblog](https://github.com/cfenollosa/bashblog).

## Usage

1. Download and install the [Go toolchain](https://go.dev/doc/install) (if not

   already installed).

2. Download comico either by cloning this repository or by downloading the files

   from GitHub.

3. Add post to the `posts/` directory. See existing examples in that directory.

4. Run `make` to generate your blog. All the blogs files (that you'd need to

   deploy to a Web server) are written to the `out/dist/` directory.

That's all!

If you'd like to launch a Web server to test your blog, do the following

(requires Python3 installed):

5. Run `make run` and in your browser visit `http://localhost:8000`.

## Documentation

### How to create a post?

1. Create a Markdown file, e.g., `posts/my-post.md`.

2. Run `make rebuild`.

See the `posts/` directory for examples.

### How to add images?

See the `html/images` directory.

### How to set the date in posts?

Dates are set directly in the post via the `Date:` field.

See the `posts/` directory for examples.

### How to set the thumbnail in posts?

Thumbnails are set directly in the post via the `Image:` field.

See the `posts/` directory for examples.

### How to delete a post?

1. Delete the file from the `posts/` directory.

2. Run `make rebuild`.

### How to change the blog's configuration, e.g., blog name, etc?

1. Edit the file `bin/main.go`.

2. Change the `blogName`, `blogDescription`, `authorName`, etc.

3. Run `make rebuild`.

### How to change the blog's appearance?

1. Edit the CSS files (see the `html/css/` directory)

2. Edit the HTML templates (see `templates/` directory)

3. Run `make rebuild`.

Any CSS files stored in the `html/css/` directory are automatically copied

to the `out/dist/` directory when running `make`.

To link new CSS files to your blog's HTML pages edit the

`templates/index.template` file and include CSS include tags.

### How to add custom HTML pages or custom files?

Any files in the `html/` directory are copied directly to the output.

Add any files or directories to the `html/` directory to have them automatically copied to the output when running `make`.

### License

The license (see `LICENSE`) covers the blog generation software included in this

repository.

The license does not cover any websites generated using this software. For

example, if you use this software to generate your blog, the posts and the HTML

pages generated are owned by you and this license does not apply to them.

In other words, you retain all the rights of the contents of your blog even if

those contents were generated by this software.