Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/skar-software/svelte-blog-git-book
Svelte Static site generation using Markdown to manage web pages, build blogs and create git book like documentation
https://github.com/skar-software/svelte-blog-git-book
Last synced: 21 days ago
JSON representation
Svelte Static site generation using Markdown to manage web pages, build blogs and create git book like documentation
- Host: GitHub
- URL: https://github.com/skar-software/svelte-blog-git-book
- Owner: skar-software
- License: mit
- Created: 2024-08-16T16:48:23.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-10-16T17:18:00.000Z (3 months ago)
- Last Synced: 2024-11-09T18:12:12.139Z (3 months ago)
- Language: Svelte
- Homepage:
- Size: 1.67 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Svelte Blog and Gitbook
Use the project to deploy a blog or git book like documentation component in your website. The content is in Markdown and is rendered to HTML pages using Static Site Generation.
## Running the Server in Local using Docker Images
Pull docker image from Docker Hub
```
docker pull anonranger/svelte-blogger
```
Start the docker server at [localhost:3000](http://localhost:3000)
```
docker run --name blogger -d -p 3000:4173 anonranger/svelte-blogger
```
## Documentation of Folder structure - Guidance on where to add content
**User Managed Content**
For blog or documentation component, user to add content and images in the folders below.
**static/content_images/content** - user to add markdown content
**static/content_images/images** - user to add images
**src/stores** - user to manage the mapping of content
**System Files**
src/api - static site rendering
src/components - Svelte components that render unique UI
src/routes - Mapping of route and components
src/shared - common libraries
## Blog Screenshots
1. Blog articles listing with category filtering
2. Blog article page
## Gitbook like Documentation Screenshots
1. Side Navbar
2. Complete page
## Getting Started with Installation
### 1. Clone the Repository
Clone the project repository to your local machine:
```bash
git clone https://github.com/skar-software/svelte-blogger.git
cd svelte-blogger
```
### 2. Install Dependencies
Install the project dependencies using npm:
```bash
npm install
```
### 3. Run the Development Server
To start the development server with hot-reloading:
```bash
npm run dev
```
Your application should now be running at [http://localhost:5173](http://localhost:5173).
### 4. Build for Production
To build the application for production:
```bash
npm run build
```
This command will generate the production-ready files in the `dist` directory.
### 5. Preview the Production Build
To preview the production build locally:
```bash
npm run preview -- --host
```
This command will serve the built application, typically on port 4173, and make it accessible via the network.
## Running with Docker
If you prefer to run the application inside a Docker container, follow these steps:
### 1. Build the Docker Image
Build the Docker image using the Dockerfile:
```bash
docker build -t blogger .
```
### 2. Run the Docker Container
Run the Docker container, exposing the application on port 4173:
```bash
docker run -p 4173:4173 blogger
```
Your application will be accessible at [http://localhost:4173](http://localhost:4173).
## Scripts
Here are the main scripts available in the project:
- **`npm run dev`**: Starts the development server with hot-reloading.
- **`npm run build`**: Builds the application for production.
- **`npm run preview`**: Previews the production build locally.
- **`npm run start`**: (In Docker) Starts the production server.