Skip to content

crydensync/crydensync-docs-web

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

# CrydenSync Documentation Website

Welcome to the CrydenSync docs! This repository contains all the markdown files for the official CrydenSync documentation website.

## 🚀 Quick Start

```bash
# Clone the docs repo
git clone https://github.com/crydensync/crydensync-docs-web
cd crydensync-docs-web

# Build with your favorite static site generator
# (Next.js, Hugo, Docusaurus, MkDocs, etc.)

🎨 Design Tokens

/* Brand colors */
--primary: #6366f1;    /* Indigo - trust, security */
--secondary: #10b981;  /* Emerald - growth, offline */
--accent: #f59e0b;     /* Amber - warning, rate limiting */
--dark: #1f2937;       /* Near black - authority */
--light: #f9fafb;      /* Off-white - 
/* Typography */
--font-mono: 'JetBrains Mono', monospace;  /* Code */
--font-sans: 'Inter', sans-serif;          /* Content */

🛠️ Building the Site

Option 1: Docusaurus (React)

npx create-docusaurus@latest cryden-docs classic
# Copy markdown files to docs/

Option 2: Hugo (Go)

hugo new site cryden-docs
# Copy markdown files to content/

Option 3: MkDocs (Python)

pip install mkdocs
mkdocs new cryden-docs
# Copy markdown files to docs/

📦 Assets Needed

· Logo (SVG format) · Architecture diagrams · Code screenshots (Carbon) · Social cards for sharing

🌐 SEO Keywords

cryden, crydensync, authentication, go auth, golang auth, offline auth,
jwt, refresh tokens, rate limiting, audit logs, sqlite auth, postgres auth,
mongodb auth, open source auth, self-hosted auth

🤝 Contributing

Found a typo? Want to improve an example? PRs welcome!

  1. Fork the repo
  2. Create a branch (git checkout -b fix/typo)
  3. Commit changes (git commit -m "Fix typo in philosophy")
  4. Push (git push origin fix/typo)
  5. Open a PR

📄 License

MIT © CrydenSync


Built for developers, by developers. With ❤️ from Nigeria.

About

For now markdown files, frontend devs are working on official website and docs.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages