-
-
Notifications
You must be signed in to change notification settings - Fork 398
## Spec Editor's Guide
ReSpec is a tool that makes writing specifications easier. ReSpec handles things like styling, referential integrity, bibliographical data, and other mundane tasks.
- Dynamic Content Generation Automatically generates Table of Contents, References, and Bibliographies.
Supports automatic pluralization and aliases/synonyms for terms, ensuring consistency throughout the document.
-
WebIDL Integration Provides support for WebIDL (Web Interface Definition Language), which is essential for defining interfaces in web specifications.
-
Customizable Configuration Allows users to configure ReSpec via a JSON object or directly through the URL, enabling flexibility in how documents are structured and styled.
-
Linting and Validation Includes built-in linting tools to check for accessibility issues, unused definitions, and other common errors.
Ensures compliance with W3C standards and best practices.
-
External Includes Supports the inclusion of external files or content, making it easier to reuse and maintain shared sections across multiple documents.
-
Interactive Features Enables interactive elements like collapsible sections, live examples, and inline code highlighting for better user engagement.
-
Custom Styling Offers options for adding custom styles and branding, allowing documents to align with organizational guidelines.
-
Version Control and Collaboration Integrates seamlessly with GitHub, enabling version control and collaborative editing.
-
Static Snapshots Provides tools to create static snapshots of documents, which are useful for archiving or publishing finalized versions.
-
Accessibility and Internationalization Includes features to ensure documents are accessible to a wide audience and supports internationalization for multilingual specifications.
These features make ReSpec a versatile and efficient tool for creating professional-grade technical documents. If you'd like to explore any of these features in detail or need help implementing them, let me know!
- addSectionLinks
- authors
- caniuse
- edDraftURI
- editors
- favicon
- format (markdown)
- formerEditors
- github
- highlightVars
- isPreview
- license
- lint
- localBiblio
- logos
- maxTocLevel
- mdn
- modificationDate
- noTOC
- otherLinks
- pluralize
- postProcess
- preProcess
- previousDiffURI
- previousMaturity
- previousPublishDate
- prevRecShortname
- prevRecURI
-
processVersion(Deprecated) - publishDate
-
refNote(Deprecated) - shortName
- specStatus
- subjectPrefix
- subtitle
- testSuiteURI
- xref
- additionalCopyrightHolders
-
addPatentNote(Deprecated) - alternateFormats
- canonicalURI
- charterDisclosureURI
- copyrightStart
- crEnd
-
darkMode(deprecated, use dark mode) - doJsonLd
- errata
- group
- implementationReportURI
- lcEnd
- level
- noRecTrack
- prevED
- submissionCommentNumber
-
wg(Deprecated) -
wgId(Deprecated) -
wgPatentPolicy(Deprecated) -
wgPatentURI(Deprecated) - wgPublicList
-
wgURI(Deprecated)
a11y
check-punctuation
local-refs-exist
no-headingless-sections
no-http-props
no-unused-vars
no-unused-dfns
informative-dfn
privsec-section
wpt-tests-exist
Handled by ReSpec for you.
- data-abbr
-
data-cite(Not recommended) - data-dfn-for
- data-dfn-type
- data-format
- data-include-format
- data-include-replace
- data-include
- data-link-for
- data-link-type
- data-local-lt
- data-lt-no-plural
- data-lt-noDefault
- data-lt
- data-number
- data-oninclude
- data-sort
- data-tests
-
data-transform(Deprecated) - data-type
- dir
- lang