mirror of
https://github.com/wassname/talk.git
synced 2026-06-28 21:47:49 +08:00
d3931db285
* docs: add docs for comment count integration * docs: update count docs * chore: improve integration docs
227 lines
6.6 KiB
YAML
227 lines
6.6 KiB
YAML
# Hexo Configuration
|
|
## Docs: https://hexo.io/docs/configuration.html
|
|
## Source: https://github.com/hexojs/hexo/
|
|
|
|
# Site
|
|
title: Talk Documentation
|
|
subtitle:
|
|
description: >
|
|
Documentation and guides for Coral by Vox Media
|
|
google_analytics: UA-73335347-5
|
|
author:
|
|
language: en
|
|
timezone:
|
|
|
|
# URL
|
|
## If your site is put in a subdirectory, set url as 'http://yoursite.com/child' and root as '/child/'
|
|
url: https://docs.coralproject.net/talk/
|
|
root: /talk/
|
|
permalink: :permalink/
|
|
permalink_defaults:
|
|
|
|
# Directory
|
|
source_dir: source
|
|
public_dir: public/talk
|
|
tag_dir: tags
|
|
archive_dir: archives
|
|
category_dir: categories
|
|
code_dir: downloads/code
|
|
i18n_dir: :lang
|
|
skip_render:
|
|
|
|
# Writing
|
|
new_post_name: :title.md # File name of new posts
|
|
default_layout: doc
|
|
titlecase: false # Transform title into titlecase
|
|
external_link: true # Open external links in new tab
|
|
filename_case: 0
|
|
render_drafts: false
|
|
post_asset_folder: false
|
|
relative_link: false
|
|
future: true
|
|
highlight:
|
|
enable: false
|
|
|
|
# Home page setting
|
|
# path: Root path for your blogs index page. (default = '')
|
|
# per_page: Posts displayed per page. (0 = disable pagination)
|
|
# order_by: Posts order. (Order by date descending by default)
|
|
index_generator:
|
|
path: ""
|
|
|
|
# Category & Tag
|
|
default_category: uncategorized
|
|
category_map:
|
|
tag_map:
|
|
|
|
# Date / Time format
|
|
## Hexo uses Moment.js to parse and display date
|
|
## You can customize the date format as defined in
|
|
## http://momentjs.com/docs/#/displaying/format/
|
|
date_format: YYYY-MM-DD
|
|
time_format: HH:mm:ss
|
|
|
|
# Extensions
|
|
## Plugins: https://hexo.io/plugins/
|
|
## Themes: https://hexo.io/themes/
|
|
theme: coral
|
|
|
|
# Deployment
|
|
## Docs: https://hexo.io/docs/deployment.html
|
|
deploy:
|
|
type:
|
|
|
|
sidebar:
|
|
top:
|
|
- title: GitHub
|
|
url: https://github.com/coralproject/
|
|
- title: Docker
|
|
url: https://hub.docker.com/r/coralproject/talk/
|
|
side:
|
|
- title: Version 5
|
|
children:
|
|
- title: Getting Started
|
|
children:
|
|
- title: Installing
|
|
url: /
|
|
- title: Configuration
|
|
url: /v5/configuration/
|
|
- title: Developing
|
|
url: /v5/developing/
|
|
- title: Integration
|
|
children:
|
|
- title: CMS Integration
|
|
url: /v5/integrating/cms/
|
|
- title: Single Sign On
|
|
url: /v5/integrating/sso/
|
|
- title: Comment Count
|
|
url: /v5/integrating/counts/
|
|
- title: API
|
|
children:
|
|
- title: GraphQL Overview
|
|
url: /v5/api/overview/
|
|
- title: Version 4
|
|
children:
|
|
- title: Installation
|
|
children:
|
|
- title: Talk Quickstart
|
|
url: /installation-quickstart
|
|
- title: Installation from Docker
|
|
url: /installation-from-docker/
|
|
- title: Installation from Source
|
|
url: /installation-from-source/
|
|
- title: Planning your Talk Architecture
|
|
url: /planning-architecture/
|
|
- title: Pre-Launch Checklist
|
|
url: /pre-launch-checklist/
|
|
- title: Configuration
|
|
children:
|
|
- title: Required Configuration
|
|
url: /configuration/
|
|
- title: Advanced Configuration
|
|
url: /advanced-configuration/
|
|
- title: Configuration with CLI tools
|
|
url: /configuration-cli-tools/
|
|
- title: Integrating
|
|
children:
|
|
- title: Authentication
|
|
url: /integrating/authentication/
|
|
- title: CMS Integration
|
|
url: /integrating/cms-integration/
|
|
- title: Asset Scraping
|
|
url: /integrating/asset-scraping/
|
|
- title: Configuring the Comment Stream
|
|
url: /integrating/configuring-comment-stream/
|
|
- title: Configuring the Admin
|
|
url: /integrating/configuring-admin/
|
|
- title: Notifications
|
|
url: /integrating/notifications/
|
|
- title: Event Tracking and Metrics
|
|
url: /integrating/event-tracking-metrics/
|
|
- title: Styling and CSS
|
|
url: /integrating/styling-css/
|
|
- title: Translations and i18n
|
|
url: /integrating/translations-i18n/
|
|
- title: GDPR Compliance
|
|
url: /integrating/gdpr/
|
|
- title: Accelerated Mobile Page
|
|
url: /integrating/amp/
|
|
- title: Product Guide
|
|
children:
|
|
- title: How Talk Works
|
|
url: /how-talk-works/
|
|
- title: Commenter Features
|
|
url: /commenter-features/
|
|
- title: Moderator Features
|
|
url: /moderator-features/
|
|
- title: User Roles in Talk
|
|
url: /roles/
|
|
- title: Trust
|
|
url: /trust/
|
|
- title: Toxic Comments
|
|
url: /toxic-comments/
|
|
- title: Configuring Talk
|
|
url: /configuring-talk/
|
|
- title: Plugins
|
|
children:
|
|
- title: Plugins Overview
|
|
url: /plugins/
|
|
- title: Plugin Directory
|
|
url: /plugins-directory/
|
|
- title: Plugin Recipes
|
|
url: /plugin-recipes/
|
|
- title: API
|
|
children:
|
|
- title: GraphQL Overview
|
|
url: /api/overview/
|
|
- title: GraphQL Reference
|
|
url: /api/graphql/
|
|
- title: Server Plugin API
|
|
url: /api/server/
|
|
- title: Client Plugin API
|
|
url: /api/client/
|
|
- title: Plugin Slots API
|
|
url: /api/slots/
|
|
- title: Tutorials
|
|
children:
|
|
- title: Creating a Basic Plugin
|
|
url: /building-basic-plugin/
|
|
- title: Customizing Plugins with Coral UI
|
|
url: /customizing-plugins-coral-ui/
|
|
- title: When You've Installed Talk
|
|
url: /when-youve-installed-talk/
|
|
- title: Embedding Talk in Native Mobile Apps
|
|
url: /embedding-in-native-mobile-apps/
|
|
- title: Migrating
|
|
children:
|
|
- title: Migrating from v3.x.x
|
|
url: /migration/3/
|
|
- title: Migrating to v4.0.0
|
|
url: /migration/4/
|
|
- title: Migrating to v4.1.0
|
|
url: /migration/4.1/
|
|
- title: FAQ & Troubleshooting
|
|
children:
|
|
- title: FAQ
|
|
url: /faq/
|
|
- title: Troubleshooting Tips
|
|
url: /troubleshooting-tips/
|
|
- title: Contact
|
|
url: /contact/
|
|
|
|
marked:
|
|
gfm: true
|
|
pedantic: false
|
|
sanitize: false
|
|
tables: true
|
|
breaks: false
|
|
smartLists: true
|
|
smartypants: true
|
|
modifyAnchors: 1
|
|
autolink: true
|
|
|
|
node_sass:
|
|
outputStyle: compressed
|
|
precision: 5
|
|
sourceComments: false
|