Skip to content

README.md

Latest commit

 

History

History
77 lines (53 loc) · 2.21 KB

README.md

File metadata and controls

77 lines (53 loc) · 2.21 KB

Lexical.cloud Site Generator

This repo generates a static website based on the Docsy theme for Hugo. The docsy theme, target content and generated site are distinct submodules of this project.

Setup Env

It's easiest to launch the dev container for this project on GitHub Codespaces.

OR, follow the setup instructions below.

Install Prerequisite tools:

Setup Project

Clone repository:

git clone <url-here>
cd ${PROJECT_DIR}

Then:

make setup

Start Using

Run local server:

make run

Generate static site:

make build

Contributing

Most changes for the Lexical.cloud project will occur against the lexical-cloud-docs repo. Afterwards, those data contributions will be incorporated into this repository for rendering.

Customizations to that rendering require:

  • Fork this repository
  • Create new branch from main
  • Launch project in Github Codespaces (optional)
  • Make desired changes

Preview and test within Github Codespaces. (recommended)

OR, deploy to Github Pages via provided GitHub Action:

  • Commit and push changes to branch on fork.
  • Enable Github Actions under Pages in Settings.
  • Remove main from deployment branches in gh-pages environment.
  • Enable workflows for the forked repo in Actions.
  • Run the deploy-gh-pages workflow against your desired branch.
  • Visit {username}.github.io/lexical-cloud-docs-hugo/

Contribute back changes:

  • Commit and push desired changes to branch on fork.
  • Send a pull request back to this repository.
  • Work with project admins on the PR process.

License Summary

A CC BY-SA 4.0 license is intended for the content produced from this repo. See the LICENSE file.

The Apache 2.0 license and relevant notices for the Docsy theme are also found in this repo. See LICENSE-DOCY and NOTICES-DOCSY files.

Each submodule of this repo has a license file included. See the LICENSE file in each repo.