Skip to content

Latest commit

Β 

History

15 Commits

Folders and files

NameName
Last commit message
Last commit date
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

MiniBlog

Logo
[INPUT SCREENSHOT HERE]

Welcome to MiniBlog, a lightweight and intuitive web application designed to help you create, manage, and export your blog posts with ease. Whether you're a beginner or an experienced blogger, MiniBlog offers a seamless experience to organize your thoughts and share them with the world.

Table of Contents

Features

  • Create, Edit, and Delete Posts: Easily manage your blog content with user-friendly forms.
  • Export and Import JSON: Backup your blog data or migrate it to another instance effortlessly.
  • Command Autocomplete: Utilize intuitive commands for streamlined blogging operations.
  • Zoom and Sort: Customize your viewing experience with zoom levels and sorting options.
  • Search Functionality: Quickly find posts using the search bar with support for exact and partial matches.
  • Responsive Design: Access and manage your blog from any device with a clean and responsive interface.

Screenshots

Home Page

Home Page
[INPUT SCREENSHOT HERE]

Add New Post Form

Add Post Form
[INPUT SCREENSHOT HERE]

Editing a Post

Edit Post
[INPUT SCREENSHOT HERE]

Exporting JSON

Export JSON
[INPUT SCREENSHOT HERE]

Importing JSON

Import JSON
[INPUT SCREENSHOT HERE]

Command Autocomplete

Command Autocomplete
[INPUT SCREENSHOT HERE]

Zoom and Sort Controls

Zoom and Sort
[INPUT SCREENSHOT HERE]

Usage

Accessing MiniBlog

Access your MiniBlog application through GitHub Pages:

Live Demo

Adding a New Post

  1. Open the Add Post Form

    Click on the βž• Add New Post button located in the control panel.

    Open Add Post Form
    [INPUT SCREENSHOT HERE]

  2. Fill in the Post Details

    • Picture URL: Enter the URL of an image to associate with the post. If left blank, a random image will be assigned automatically.
    • Background Color: Choose a background color for the image container.
    • Title: Provide a title for your post.
    • Description: Enter a brief description.
    • Date: Input the date in MM/DD/YYYY format. Defaults to today's date if not specified.
    • Body: Write your content using Markdown syntax.

    Fill Post Details
    [INPUT SCREENSHOT HERE]

  3. Save the Post

    Click the πŸ’Ύ Save Post button to add the post to your blog.

    Save Post
    [INPUT SCREENSHOT HERE]

Editing a Post

  1. Locate the Post

    Find the post you wish to edit in the Latest Grid.

  2. Open the Edit Form

    Click on the ✏️ Edit Post button associated with the post.

    Edit Post Button
    [INPUT SCREENSHOT HERE]

  3. Modify the Details

    Update the desired fields in the form.

  4. Save Changes

    Click the πŸ’Ύ Save Post button to apply the changes.

Deleting a Post

  1. Locate the Post

    Find the post you wish to delete in the Latest Grid.

  2. Delete the Post

    Click on the πŸ—‘οΈ Delete Post button associated with the post.

    Delete Post Button
    [INPUT SCREENSHOT HERE]

  3. Confirm Deletion

    A confirmation prompt will appear. Click OK to proceed.

Exporting Your Blog

  1. Click the Export Button

    Click on the πŸ“₯ Export JSON button in the control panel.

    Export JSON Button
    [INPUT SCREENSHOT HERE]

  2. Download the JSON File

    A JSON file containing your blog data will be downloaded to your device.

    Export Successful
    [INPUT SCREENSHOT HERE]

Importing Your Blog

  1. Click the Import Button

    Click on the πŸ“‚ Load JSON button in the control panel.

    Load JSON Button
    [INPUT SCREENSHOT HERE]

  2. Select the JSON File

    Choose the previously exported JSON file from your device.

    Select JSON File
    [INPUT SCREENSHOT HERE]

  3. Import and View Your Blog

    The application will load the data, and your posts will appear in the Latest Grid.

    Import Successful
    [INPUT SCREENSHOT HERE]

Using Commands

MiniBlog supports various commands to enhance your blogging experience. To access commands, type / in the Command Input field.

  1. Open Command Input

    Click on the Command Input field and type / to see available commands.

    Command Input
    [INPUT SCREENSHOT HERE]

  2. Select a Command

    As you type, a suggestion box will appear. Use the arrow keys or mouse to select a command.

    Command Suggestions
    [INPUT SCREENSHOT HERE]

  3. Execute the Command

    Press Enter to execute the selected command.

Zooming and Sorting

Zooming:

  • Click the πŸ” Zoom button to cycle through different zoom levels (75%, 100%, 125%, 150%).

    Zoom Button
    [INPUT SCREENSHOT HERE]

Sorting:

  • Click the 🚫 Sort button to cycle through sorting options:

    • 🚫 No Sorting
    • πŸ—“οΈ Sort by Date
    • πŸ”‘ Sort by Name
    • 🎨 Sort by Color

    Sort Button
    [INPUT SCREENSHOT HERE]

Clearing All Data

  1. Click the Clear Button

    Click on the 🧹 Clear All button in the control panel.

    Clear Button
    [INPUT SCREENSHOT HERE]

  2. Confirm Clearing

    A confirmation prompt will appear. Click OK to remove all data from local storage.

Command Reference

MiniBlog supports the following commands to streamline your blogging process. Access them by typing / in the Command Input field.

/createpost 'Your Title Here'

Description: Creates a new blog post with the provided title.

Example:

/createpost 'My First Blog Post'

/generatepost 'Your Prompt Here'

Description: Generates blog content based on the provided prompt using OpenAI's API.

Example:

/generatepost 'Write a blog post about the benefits of remote work.'

/saveapikey 'Your_API_Key_Here'

Description: Registers your OpenAI API key for content generation.

Example:

/saveapikey 'sk-XXXXXXXXXXXXXXXXXXXXXXXXXXXX'

/clearapikey

Description: Removes the currently registered OpenAI API key.

Example:

/clearapikey

License

This project is licensed under the MIT License.

Acknowledgements


Made with ❀️ by Your Name


[INPUT SCREENSHOT HERE]

About

An easy to deploy MiniBlog!

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages