ignore build folder and update documentation
This commit is contained in:
2
.gitignore
vendored
2
.gitignore
vendored
@@ -2,7 +2,7 @@
|
|||||||
node_modules/
|
node_modules/
|
||||||
|
|
||||||
# Build output
|
# Build output
|
||||||
#build/
|
build/
|
||||||
|
|
||||||
# Logs
|
# Logs
|
||||||
*.log
|
*.log
|
||||||
|
|||||||
@@ -23,6 +23,7 @@ This project builds a presentation deck for Marp based on Markdown files.
|
|||||||
- Use `slides/` directory for Markdown slide files
|
- Use `slides/` directory for Markdown slide files
|
||||||
- Use `assets/` for images and media files
|
- Use `assets/` for images and media files
|
||||||
- Use `themes/` for custom Marp themes
|
- Use `themes/` for custom Marp themes
|
||||||
|
- Use `build/` directory for generated output files (ignored by git)
|
||||||
|
|
||||||
### Naming Conventions
|
### Naming Conventions
|
||||||
- Slide files: `index.md`, `additional-slides.md` (descriptive names)
|
- Slide files: `index.md`, `additional-slides.md` (descriptive names)
|
||||||
|
|||||||
@@ -48,7 +48,7 @@ Generate HTML files from Markdown:
|
|||||||
```bash
|
```bash
|
||||||
npm run build
|
npm run build
|
||||||
```
|
```
|
||||||
Output files are created in the `build/` directory.
|
Output files are created in the `build/` directory (ignored by git).
|
||||||
|
|
||||||
### Export Formats
|
### Export Formats
|
||||||
|
|
||||||
@@ -56,13 +56,13 @@ Output files are created in the `build/` directory.
|
|||||||
```bash
|
```bash
|
||||||
npm run export:pdf
|
npm run export:pdf
|
||||||
```
|
```
|
||||||
Generates PDF files in the `build/` directory.
|
Generates PDF files in the `build/` directory (ignored by git).
|
||||||
|
|
||||||
#### HTML Export
|
#### HTML Export
|
||||||
```bash
|
```bash
|
||||||
npm run export:html
|
npm run export:html
|
||||||
```
|
```
|
||||||
Generates standalone HTML files in the `build/` directory.
|
Generates standalone HTML files in the `build/` directory (ignored by git).
|
||||||
|
|
||||||
### Watch Mode
|
### Watch Mode
|
||||||
|
|
||||||
@@ -82,7 +82,7 @@ malta-slides-marp/
|
|||||||
├── assets/ # Images and media files
|
├── assets/ # Images and media files
|
||||||
├── themes/ # Custom CSS themes
|
├── themes/ # Custom CSS themes
|
||||||
│ └── custom-theme.css # Example custom theme
|
│ └── custom-theme.css # Example custom theme
|
||||||
├── build/ # Generated output files
|
├── build/ # Generated output files (ignored by git)
|
||||||
├── node_modules/ # Dependencies
|
├── node_modules/ # Dependencies
|
||||||
├── package.json # Project configuration
|
├── package.json # Project configuration
|
||||||
├── Makefile # Alternative build commands
|
├── Makefile # Alternative build commands
|
||||||
|
|||||||
Binary file not shown.
|
Before Width: | Height: | Size: 1.1 MiB |
490
build/index.html
490
build/index.html
File diff suppressed because one or more lines are too long
Reference in New Issue
Block a user