diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 20 |
1 files changed, 18 insertions, 2 deletions
@@ -4,6 +4,19 @@ A complete guide to self-hosting Docsify with no external CDN dependencies. We f --- +## Quick Start + +If you just want a working site, run the bundled script from your document root. It performs every step in this guide automatically: it downloads and version-pins all assets, writes `index.html`, creates starter content, and generates a SHA-256 checksum manifest. + +```bash +cd /path/to/your/docroot +bash /path/to/scripts/setup.sh +``` + +Re-running is safe: it refreshes the vendored assets and regenerates `index.html`, but never overwrites your Markdown files (`README.md`, `_sidebar.md`, or any pages you have added). Everything below explains what the script does and how to perform each step by hand. + +--- + ## Prerequisites - Any static web server (Apache, nginx, Caddy, or similar) @@ -374,10 +387,13 @@ Since you are creating these files yourself, you already own them. Just ensure t are readable by your web server's user (e.g. `www-data`, `nginx`, or `caddy`): ```bash -find . -type f -exec chmod 644 {} \; -find . -type d -exec chmod 755 {} \; +find . -path './.*' -prune -o -type f -exec chmod 644 {} \; +find . -path './.*' -prune -o -type d -exec chmod 755 {} \; ``` +The `-path './.*' -prune` clause skips dotfiles and dotdirectories, so if your document +root is a Git repository these commands leave its `.git/` permissions untouched. + --- ## Serving the Site |