Skip to content
This repository was archived by the owner on Nov 21, 2025. It is now read-only.

Commit 2889e84

Browse files
authored
Update README.md
Update Readme
1 parent 4dcdee1 commit 2889e84

File tree

1 file changed

+5
-11
lines changed

1 file changed

+5
-11
lines changed

README.md

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,15 @@ This API documentation is live at https://synbiohub.github.io/api-docs/
44

55
This project is a customized API documentation site based on Slate.
66

7-
📄 Forked from: [slatedocs/slate](https://github.com/slatedocs/slate)
7+
- Forked from: [slatedocs/slate](https://github.com/slatedocs/slate)
88

9-
🐳 Built using Docker: Follows instructions from [Using Slate in Docker](https://github.com/slatedocs/slate/wiki/Using-Slate-in-Docker)
9+
- Built using Docker: Follows instructions from [Using Slate in Docker](https://github.com/slatedocs/slate/wiki/Using-Slate-in-Docker)
1010

11-
⚙️ Automated Build: GitHub Actions workflow adapted from [Slate Documentation Builder](https://github.com/marketplace/actions/slate-documentation-builder)
11+
- Automated Build: GitHub Actions workflow adapted from [Slate Documentation Builder](https://github.com/marketplace/actions/slate-documentation-builder)
1212

13-
✏️ Key Differences from the Original Slate Repo:
13+
- Key Differences from the Original Slate Repo:
1414
Customized `index.html.md` with project-specific API details
1515

16-
Updated logo for branding
17-
18-
This `README.md` for clear project guidance
19-
20-
21-
2216
### Run a local instance:
2317

2418
#### Building Slate:
@@ -44,4 +38,4 @@ and you will be able to access your site at http://localhost:4567 until you stop
4438

4539
```git push```
4640

47-
```./deploy.sh```
41+
GitHub Actions automatically build and deploy your site to GitHub Pages

0 commit comments

Comments
 (0)