feat(docs): docs settings, group values, post summaries, weight sorting (branch updated) (#4280)
This commit is contained in:
silverwebb925
GitHub
parent
7e510585bb
commit
512e6370b2
@ -1,7 +1,7 @@
|
||||
---
|
||||
group: Intro
|
||||
weight: 3
|
||||
title: Add to Your Site
|
||||
weight: 20
|
||||
group: intro
|
||||
---
|
||||
|
||||
You can adapt Netlify CMS to a wide variety of projects. It works with any content written in markdown, JSON, YAML, or TOML files, stored in a repo on [GitHub](https://github.com/), [GitLab](https://about.gitlab.com/), or [Bitbucket](https://bitbucket.org). You can also create your own custom backend.
|
||||
|
||||
@ -1,7 +1,8 @@
|
||||
---
|
||||
title: Architecture
|
||||
position: 90
|
||||
group: contributing
|
||||
group: Contributing
|
||||
weight: 200
|
||||
---
|
||||
|
||||
Netlify CMS is a React application, using Redux for state management with immutable data structures (immutable.js).
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
title: Overview
|
||||
group: Accounts
|
||||
weight: 1
|
||||
group: accounts
|
||||
title: Overview
|
||||
---
|
||||
|
||||
A backend is JavaScript code that allows Netlify CMS to communicate with a service that stores content - typically a Git host like GitHub or GitLab. It provides functions that Netlify CMS can use to do things like read and update files using API's provided by the service.
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
title: Beta Features!
|
||||
weight: 200
|
||||
group: configuration
|
||||
group: Configuration
|
||||
---
|
||||
|
||||
We run new functionality in an open beta format from time to time. That means that this functionality is totally available for use, and we _think_ it might be ready for primetime, but it could break or change without notice.
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
title: Bitbucket
|
||||
group: Accounts
|
||||
weight: 20
|
||||
group: accounts
|
||||
title: Bitbucket
|
||||
---
|
||||
For repositories stored on Bitbucket, the `bitbucket` backend allows CMS users to log in directly with their Bitbucket account. Note that all users must have write access to your content repository for this to work.
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Cloudinary
|
||||
group: media
|
||||
group: Media
|
||||
weight: 10
|
||||
---
|
||||
Cloudinary is a digital asset management platform with a broad feature set, including support for responsive image generation and url based image transformation. They also provide a powerful media library UI for managing assets, and tools for organizing your assets into a hierarchy.
|
||||
|
||||
@ -1,8 +1,7 @@
|
||||
---
|
||||
title: Collection Types
|
||||
group: collections
|
||||
weight: 27
|
||||
|
||||
group: Collections
|
||||
weight: 10
|
||||
---
|
||||
All editable content types are defined in the `collections` field of your `config.yml` file, and display in the left sidebar of the Content page of the editor UI.
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
title: Configuration Options
|
||||
group: configuration
|
||||
weight: 23
|
||||
group: Configuration
|
||||
weight: 10
|
||||
---
|
||||
|
||||
## Configuration File
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
title: Contributor Guide
|
||||
weight: 20
|
||||
group: contributing
|
||||
group: Contributing
|
||||
---
|
||||
|
||||
We're hoping that Netlify CMS will do for the [JAMstack](https://www.jamstack.org) what WordPress did for dynamic sites back in the day. We know we can't do that without building a thriving community of contributors and users, and we'd love to have you join us.
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
title: Creating Custom Widgets
|
||||
group: fields
|
||||
weight: 35
|
||||
group: Fields
|
||||
weight: 20
|
||||
---
|
||||
The NetlifyCMS exposes a `window.CMS` a global object that you can use to register custom widgets, previews, and editor plugins. The same object is also the default export if you import Netlify CMS as an npm module. The available widget extension methods are:
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
title: Creating Custom Previews
|
||||
weight: 50
|
||||
group: customization
|
||||
group: Customization
|
||||
---
|
||||
|
||||
The NetlifyCMS exposes a `window.CMS` global object that you can use to register custom widgets, previews and editor plugins. The available customization methods are:
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
title: Deploy Preview Links
|
||||
group: workflow
|
||||
group: Workflow
|
||||
weight: 10
|
||||
title: Deploy Preview Links
|
||||
---
|
||||
When using the editorial workflow, content editors can create and save content without publishing it
|
||||
to a live site. Deploy preview links provide a way to view live content when it has not been
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Examples
|
||||
group: contributing
|
||||
group: Contributing
|
||||
weight: 110
|
||||
---
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
title: External OAuth Clients
|
||||
weight: 40
|
||||
group: accounts
|
||||
group: Accounts
|
||||
weight: 60
|
||||
---
|
||||
|
||||
If you would like to facilitate your own OAuth authentication rather than use Netlify's service or implicit grant, you can use one of the community-maintained projects below. Feel free to hit the "Edit this page" button if you'd like to add yours!
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
title: Gatsby
|
||||
group: guides
|
||||
weight: 20
|
||||
group: Guides
|
||||
weight: 10
|
||||
---
|
||||
This guide will help you get started using Netlify CMS and Gatsby.
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
title: Git Gateway
|
||||
weight: 10
|
||||
group: accounts
|
||||
group: Accounts
|
||||
---
|
||||
|
||||
[Git Gateway](https://github.com/netlify/git-gateway) is a Netlify open source project that allows you to add editors to your site CMS without giving them direct write access to your GitHub or GitLab repository. (For Bitbucket repositories, use the [Bitbucket backend](#bitbucket-backend) instead.)
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
title: GitHub
|
||||
weight: 20
|
||||
group: accounts
|
||||
group: Accounts
|
||||
weight: 30
|
||||
---
|
||||
|
||||
For repositories stored on GitHub, the `github` backend allows CMS users to log in directly with their GitHub account. Note that all users must have push access to your content repository for this to work.
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
title: GitLab
|
||||
weight: 20
|
||||
group: accounts
|
||||
group: Accounts
|
||||
weight: 40
|
||||
---
|
||||
For repositories stored on GitLab, the `gitlab` backend allows CMS users to log in directly with their GitLab account. Note that all users must have push access to your content repository for this to work.
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Hugo
|
||||
group: guides
|
||||
group: Guides
|
||||
weight: 20
|
||||
---
|
||||
## Introduction
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
title: Overview
|
||||
group: Intro
|
||||
weight: 1
|
||||
group: intro
|
||||
---
|
||||
|
||||
Netlify CMS is an open source content management system for your Git workflow that enables you to provide editors with a friendly UI and intuitive workflows. You can use it with any static site generator to create faster, more flexible web projects. Content is stored in your Git repository alongside your code for easier versioning, multi-channel publishing, and the option to handle content updates directly in Git.
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
title: Jekyll
|
||||
group: guides
|
||||
weight: 20
|
||||
group: Guides
|
||||
weight: 30
|
||||
---
|
||||
|
||||
## Introduction
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
title: Middleman
|
||||
group: guides
|
||||
weight: 30
|
||||
group: Guides
|
||||
weight: 60
|
||||
---
|
||||
This guide will help you get started using Netlify CMS and Middleman.
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
title: Netlify Large Media
|
||||
group: media
|
||||
weight: 10
|
||||
group: Media
|
||||
weight: 20
|
||||
---
|
||||
|
||||
[Netlify Large Media](https://www.netlify.com/features/large-media/) is a [Git LFS](https://git-lfs.github.com/) implementation for repositories connected to Netlify sites. This means that you can use Git to work with large asset files like images, audio, and video, without bloating your repository. It does this by replacing the asset files in your repository with text pointer files, then uploading the assets to the Netlify Large Media storage service.
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
title: NextJS
|
||||
group: guides
|
||||
weight: 20
|
||||
group: Guides
|
||||
weight: 40
|
||||
---
|
||||
This guide will help you get started using Netlify CMS with NextJS.
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
title: Nuxt
|
||||
group: guides
|
||||
weight: 20
|
||||
group: Guides
|
||||
weight: 50
|
||||
---
|
||||
This guide will walk you through how to integrate Netlify CMS with Nuxt.
|
||||
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
title: Open Authoring
|
||||
group: workflow
|
||||
group: Workflow
|
||||
weight: 20
|
||||
---
|
||||
|
||||
**This is a [beta feature](/docs/beta-features#open-authoring).**
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
title: Releases
|
||||
weight: 60
|
||||
group: intro
|
||||
group: Intro
|
||||
weight: 4
|
||||
---
|
||||
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
group: Intro
|
||||
weight: 2
|
||||
title: Start with a Template
|
||||
group: intro
|
||||
weight: 10
|
||||
---
|
||||
You can add Netlify CMS [to an existing site](/docs/add-to-your-site/), but the quickest way to get started is with a template. Found below, our featured templates deploy a bare-bones site and Netlify CMS to Netlify ([what's the difference, you ask?](../intro/#netlify-cms-vs-netlify)), giving you a fully working CMS-enabled site with just a few clicks.
|
||||
|
||||
|
||||
@ -1,8 +1,7 @@
|
||||
---
|
||||
title: Test
|
||||
weight: 30
|
||||
group: accounts
|
||||
|
||||
group: Accounts
|
||||
weight: 50
|
||||
---
|
||||
|
||||
You can use the `test-repo` backend to try out Netlify CMS without connecting to a Git repo. With this backend, you can write and publish content normally, but any changes will disappear when you reload the page. This backend powers the Netlify CMS [demo site](https://cms-demo.netlify.com/).
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
title: Uploadcare
|
||||
group: media
|
||||
weight: 10
|
||||
group: Media
|
||||
weight: 30
|
||||
---
|
||||
Uploadcare is a sleek service that allows you to upload files without worrying about maintaining a growing collection — more of an asset store than a library. Just upload when you need to, and the files are hosted on their CDN. They provide image processing controls from simple cropping and rotation to filters and face detection, and a lot more. You can check out Uploadcare's full feature set on their [website](https://uploadcare.com/).
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
title: Widgets
|
||||
weight: 30
|
||||
group: fields
|
||||
group: Fields
|
||||
weight: 10
|
||||
---
|
||||
|
||||
Widgets define the data type and interface for entry fields. Netlify CMS comes with several built-in widgets. Click the widget names in the sidebar to jump to specific widget details. We’re always adding new widgets, and you can also [create your own](../custom-widgets)!
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
title: Writing Style Guide
|
||||
weight: 30
|
||||
group: contributing
|
||||
group: Contributing
|
||||
---
|
||||
|
||||
# Netlify CMS Style Guide
|
||||
|
||||
@ -1,22 +1,22 @@
|
||||
menu:
|
||||
docs:
|
||||
- name: intro
|
||||
- name: Intro
|
||||
title: Intro to Netlify CMS
|
||||
- name: accounts
|
||||
- name: Accounts
|
||||
title: Account Settings
|
||||
- name: configuration
|
||||
- name: Configuration
|
||||
title: Configuring your Site
|
||||
- name: media
|
||||
- name: Media
|
||||
title: Media
|
||||
- name: workflow
|
||||
- name: Workflow
|
||||
title: Workflow
|
||||
- name: collections
|
||||
- name: Collections
|
||||
title: Collections
|
||||
- name: fields
|
||||
- name: Fields
|
||||
title: Fields
|
||||
- name: guides
|
||||
- name: Guides
|
||||
title: Platform Guides
|
||||
- name: customization
|
||||
- name: Customization
|
||||
title: Customizing Netlify CMS
|
||||
- name: contributing
|
||||
- name: Contributing
|
||||
title: Community
|
||||
|
||||
@ -16,79 +16,104 @@ public_folder: /img
|
||||
docs_collection: &docs_collection
|
||||
folder: website/content/docs
|
||||
create: true
|
||||
summary: '{{weight}} - {{title}}'
|
||||
preview_path: 'docs/{{slug}}'
|
||||
sortableFields: ['weight', 'title', 'group']
|
||||
fields:
|
||||
- label: Section
|
||||
name: group
|
||||
widget: relation
|
||||
collection: settings
|
||||
file: docs_sections
|
||||
searchFields: ["menu.docs.*.name", "menu.docs.*.title"]
|
||||
displayFields: ["menu.docs.*.title"]
|
||||
valueField: "menu.docs.*.name"
|
||||
- { label: 'Order', name: weight, widget: number }
|
||||
- { label: Title, name: title }
|
||||
- {
|
||||
label: Group,
|
||||
name: group,
|
||||
widget: select,
|
||||
options: [start, backends, features, reference, media, guides, customization, contributing],
|
||||
}
|
||||
- { label: Weight, name: weight, widget: number }
|
||||
- { label: Body, name: body, widget: markdown }
|
||||
|
||||
collections:
|
||||
- label: Settings
|
||||
name: settings
|
||||
hide: true
|
||||
files:
|
||||
- label: Docs Sections
|
||||
name: docs_sections
|
||||
file: website/site.yml
|
||||
fields:
|
||||
- label: menu
|
||||
name: menu
|
||||
widget: object
|
||||
fields:
|
||||
- label: Sections
|
||||
label_singular: Section
|
||||
name: docs
|
||||
widget: list
|
||||
summary: '{{title}} ({{name}})'
|
||||
fields:
|
||||
- { label: 'Full Name', name: 'title', widget: 'string' }
|
||||
- { label: 'Summary Name', name: 'name', widget: 'string' }
|
||||
|
||||
- <<: *docs_collection
|
||||
name: docs_intro
|
||||
label: 'Docs: Intro'
|
||||
filter:
|
||||
field: group
|
||||
value: intro
|
||||
value: Intro
|
||||
- <<: *docs_collection
|
||||
name: docs_accounts
|
||||
label: 'Docs: Account'
|
||||
filter:
|
||||
field: group
|
||||
value: accounts
|
||||
value: Accounts
|
||||
- <<: *docs_collection
|
||||
name: docs_configuration
|
||||
label: 'Docs: Configuration'
|
||||
filter:
|
||||
field: group
|
||||
value: configuration
|
||||
value: Configuration
|
||||
- <<: *docs_collection
|
||||
name: docs_media
|
||||
label: 'Docs: Media'
|
||||
filter:
|
||||
field: group
|
||||
value: media
|
||||
value: Media
|
||||
- <<: *docs_collection
|
||||
name: docs_workflow
|
||||
label: 'Docs: Workflow'
|
||||
filter:
|
||||
field: group
|
||||
value: workflow
|
||||
value: Workflow
|
||||
- <<: *docs_collection
|
||||
name: docs_collections
|
||||
label: 'Docs: Collections'
|
||||
filter:
|
||||
field: group
|
||||
value: collections
|
||||
value: Collections
|
||||
- <<: *docs_collection
|
||||
name: docs_fields
|
||||
label: 'Docs: Fields'
|
||||
filter:
|
||||
field: group
|
||||
value: fields
|
||||
value: Fields
|
||||
- <<: *docs_collection
|
||||
name: docs_guides
|
||||
label: 'Docs: Guides'
|
||||
filter:
|
||||
field: group
|
||||
value: guides
|
||||
value: Guides
|
||||
- <<: *docs_collection
|
||||
name: docs_customization
|
||||
label: 'Docs: Customization'
|
||||
filter:
|
||||
field: group
|
||||
value: customization
|
||||
value: Customization
|
||||
- <<: *docs_collection
|
||||
name: docs_contributing
|
||||
label: 'Docs: Contributing'
|
||||
filter:
|
||||
field: group
|
||||
value: contributing
|
||||
value: Contributing
|
||||
- name: widget_docs
|
||||
label: 'Docs: Widgets'
|
||||
folder: website/content/docs/widgets
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user