|
1 | | -# ============================================ |
2 | 1 | # EmberDocs Configuration |
3 | | -# ============================================ |
4 | | -# Copy this file to .env.local and fill in your values |
5 | | -# Never commit .env.local to version control |
| 2 | +# Copy this file to .env.local and customize as needed |
| 3 | +# All variables are optional - EmberDocs works with sensible defaults |
6 | 4 |
|
7 | | -# ============================================ |
8 | | -# Content Configuration (Optional) |
9 | | -# ============================================ |
10 | | -# Directory where markdown documentation files are stored |
11 | | -# Default: docs/examples |
12 | | -# Examples: |
13 | | -# EMBERDOCS_CONTENT_DIR=docs/content # Files in docs/content/ folder |
14 | | -# EMBERDOCS_CONTENT_DIR=content # Files in content/ folder |
15 | | -# EMBERDOCS_CONTENT_DIR=pages # Files in pages/ folder |
16 | | -EMBERDOCS_CONTENT_DIR=docs/examples |
| 5 | +# Branding (optional) |
| 6 | +# Default product name is "EmberDocs" |
| 7 | +EMBERDOCS_PRODUCT_NAME="EmberDocs" |
17 | 8 |
|
18 | | -# URL route prefix for documentation pages |
19 | | -# Default: /docs |
20 | | -# Examples: |
21 | | -# EMBERDOCS_BASE_ROUTE=/documentation # URLs: /documentation/getting-started/intro |
22 | | -# EMBERDOCS_BASE_ROUTE=/help # URLs: /help/getting-started/intro |
23 | | -# EMBERDOCS_BASE_ROUTE=/guides # URLs: /guides/getting-started/intro |
24 | | -EMBERDOCS_BASE_ROUTE=/docs |
| 9 | +# Company or organization name (used in headers, metadata, and page titles) |
| 10 | +# If set, page titles will be formatted as: {PRODUCT_NAME} - {COMPANY_NAME} Documentation |
| 11 | +EMBERDOCS_COMPANY_NAME="Your Company Name" |
25 | 12 |
|
26 | | -# Show marketing landing page on root route (/) |
27 | | -# Default: false (root route redirects to documentation index) |
28 | | -# Set to 'true' to show the EmberDocs framework marketing landing page |
29 | | -# Only needed for the EmberDocs framework repository itself |
30 | | -# EMBERDOCS_SHOW_LANDING=true |
| 13 | +# Default author name (used when document frontmatter doesn't specify an author) |
| 14 | +EMBERDOCS_DEFAULT_AUTHOR="Your Name" |
31 | 15 |
|
32 | | -# ============================================ |
33 | | -# Branding & Metadata |
34 | | -# ============================================ |
35 | | -# Default author name for documents |
36 | | -# Used when a document's frontmatter doesn't specify an author |
37 | | -# If not set, author metadata will only appear if specified in document frontmatter |
38 | | -# EMBERDOCS_DEFAULT_AUTHOR=Your Company Name |
| 16 | +# Primary URL for your company/product (used in links and metadata) |
| 17 | +EMBERDOCS_PRIMARY_URL=https://your-url.com |
39 | 18 |
|
40 | | -# Company or organization name |
41 | | -# Used in headers, metadata, and page titles |
42 | | -# If not set, product name will be used alone |
43 | | -# EMBERDOCS_COMPANY_NAME=Your Company, Inc. |
44 | | - |
45 | | -# Product name |
46 | | -# Used in headers, metadata, and page titles |
47 | | -# Default: EmberDocs |
48 | | -# EMBERDOCS_PRODUCT_NAME=Your Product Name |
49 | | - |
50 | | -# Primary URL for the company/product |
51 | | -# Used in links, metadata, and footer |
52 | | -# EMBERDOCS_PRIMARY_URL=https://example.com |
53 | | - |
54 | | -# Logo path (relative to /public directory) |
| 19 | +# Logo Configuration (optional) |
| 20 | +# Path to your logo image (relative to /public directory) |
55 | 21 | # Supported formats: PNG, SVG, JPG |
56 | | -# Example: /logos/my-logo.png |
| 22 | +# Example: /logos/your-logo.png |
57 | 23 | # EMBERDOCS_LOGO_PATH=/logos/your-logo.png |
58 | 24 |
|
| 25 | +# Navigation Links (optional) |
| 26 | +# Header navigation links as JSON object |
| 27 | +# Format: {"Label": "URL", "Another Label": "Another URL"} |
| 28 | +# External links must start with http:// or https:// |
| 29 | +# Internal links start with / |
| 30 | +# EMBERDOCS_HEADER_LINKS={"Docs": "/docs", "Features": "/#features", "GitHub": "https://github.com/yourorg"} |
| 31 | + |
| 32 | +# Footer Configuration (optional) |
59 | 33 | # Footer text content (e.g., copyright notice) |
60 | | -# Example: "Your Company © 2025" |
61 | | -# EMBERDOCS_FOOTER_TEXT=Your Company © 2025 |
| 34 | +# EMBERDOCS_FOOTER_TEXT="Your Company © 2025" |
62 | 35 |
|
63 | | -# Footer links as JSON object |
64 | | -# Format: {"Label": "URL", "Another Label": "Another URL"} |
65 | | -# Example: {"Privacy": "/privacy", "Terms": "/terms", "Contact": "/contact"} |
66 | | -# EMBERDOCS_FOOTER_LINKS={"Privacy": "/privacy", "Terms": "/terms"} |
| 36 | +# Footer links as JSON object (same format as header links) |
| 37 | +# EMBERDOCS_FOOTER_LINKS={"Privacy": "/privacy", "Terms": "/terms", "Contact": "/contact"} |
| 38 | + |
| 39 | +# Content Configuration (optional) |
| 40 | +# Custom documentation content directory (default: docs/examples) |
| 41 | +# EMBERDOCS_CONTENT_DIR=docs/examples |
| 42 | + |
| 43 | +# Custom documentation base route (default: /docs) |
| 44 | +# URLs will be served at this path instead of /docs/* |
| 45 | +# EMBERDOCS_BASE_ROUTE=/docs |
| 46 | + |
| 47 | +# Framework Mode (only for EmberDocs framework repository) |
| 48 | +# Set to true to show the EmberDocs marketing landing page at root (/) |
| 49 | +# Default: false (root redirects to /docs/index) |
| 50 | +# EMBERDOCS_SHOW_LANDING=false |
| 51 | + |
| 52 | +# Theme Selection |
| 53 | +# Choose the theme for both landing page and documentation pages |
| 54 | +# Options: dark (default), light, monochrome |
| 55 | +# EMBERDOCS_THEME=monochrome |
0 commit comments