Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/attajak/pelican-demo

Pelican Static Site Generator (Python) | Replit http://replit.com/@attajak/Pelican
https://github.com/attajak/pelican-demo

github-pages pelican

Last synced: 1 day ago
JSON representation

Pelican Static Site Generator (Python) | Replit http://replit.com/@attajak/Pelican

Awesome Lists containing this project

README

        

# Pelican Blog on Replit

This is a basic Pelican blog setup running on Replit.

## Getting Started

1. **Fork this Repl:** Click the "Fork" button in the top-right corner to create a copy of this project in your own Replit workspace.
2. **Install Dependencies:** Run the following command in the terminal:
```bash
pip install -r requirements.txt
3. Create Content:
Create new blog posts in the content folder.
Use Markdown syntax to format your content.
Refer to Pelican's documentation for more information on content structure: https://docs.getpelican.com/en/stable/
4. Generate the Website: Run the following command in the terminal:
```bash
pelican content
5. Serve the Website: Run the following command in the terminal:
```bash
pelican -s publishconf.py -r
6. View Your Blog: Open the output folder in the file browser and open
in your browser.

## Customize
Content: Edit the content folder with your own blog posts.

Theme: Change the theme by modifying the theme setting in
and installing the desired theme.

Configuration: Adjust settings in
to customize your blog's behavior.

Helpful Resources

Pelican Documentation: https://docs.getpelican.com/en/stable/

Pelican Themes: https://getpelican.com/themes.html

Replit Documentation: https://docs.replit.com/

Enjoy Blogging!

---

**Explanation:**
- **Title:** The README starts with a clear title describing the project: "Pelican Blog on Replit."
- **Getting Started:** It provides step-by-step instructions for setting up the project, including:
- Forking the Repl.
- Installing dependencies.
- Creating content.
- Generating the website.
- Serving the website.
- Viewing the blog.
- **Customization:** It outlines ways to customize the blog, including content, themes, and configuration.
- **Helpful Resources:** It provides links to relevant documentation for Pelican, Pelican themes, and Replit.
- **Enjoy Blogging!** A friendly ending encourages users to start blogging.

This README is designed to be user-friendly and guide users through the process of setting up and customizing a Pelican blog on Replit.