Document preview and deployment workflow
This commit is contained in:
7
.gitattributes
vendored
Normal file
7
.gitattributes
vendored
Normal file
@@ -0,0 +1,7 @@
|
|||||||
|
*.md text eol=lf
|
||||||
|
*.html whitespace=cr-at-eol
|
||||||
|
LICENSE text eol=lf
|
||||||
|
|
||||||
|
*.jpeg binary
|
||||||
|
*.jpg binary
|
||||||
|
*.png binary
|
||||||
31
README.md
31
README.md
@@ -1,3 +1,30 @@
|
|||||||
# links
|
# Links
|
||||||
|
|
||||||
Personal links
|
Personal links page for Walusimbi Silver, a software engineer based in Kampala, Uganda.
|
||||||
|
|
||||||
|
Live site: [links.silverwal.com](https://links.silverwal.com/)
|
||||||
|
|
||||||
|
## Local preview
|
||||||
|
|
||||||
|
The site has no build step or runtime dependencies. Serve the repository root with any static file server:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
python3 -m http.server 8000
|
||||||
|
```
|
||||||
|
|
||||||
|
Open `http://localhost:8000` in a browser.
|
||||||
|
|
||||||
|
## Structure
|
||||||
|
|
||||||
|
- `index.html` contains the page structure, styles and small scroll restoration script.
|
||||||
|
- `pic.jpeg` is the optimized avatar and social preview image.
|
||||||
|
|
||||||
|
## Updating
|
||||||
|
|
||||||
|
Edit the profile text, destinations and metadata directly in `index.html`. Keep the canonical and social image URLs aligned with the production domain.
|
||||||
|
|
||||||
|
When replacing `pic.jpeg`, use a square image and remove EXIF metadata before publishing it.
|
||||||
|
|
||||||
|
## Deployment
|
||||||
|
|
||||||
|
Deploy the repository root as a static site. The production host must serve `index.html` at `https://links.silverwal.com/` and `pic.jpeg` at the root path.
|
||||||
|
|||||||
Reference in New Issue
Block a user