https://github.com/transmissions11/drex

📖 Docusaurus template for my Open Source projects 📖
https://github.com/transmissions11/drex

Last synced: about 1 year ago
JSON representation

📖 Docusaurus template for my Open Source projects 📖

• Host: GitHub
• URL: https://github.com/transmissions11/drex
• Owner: transmissions11
• License: mit
• Created: 2019-12-19T15:38:43.000Z (over 6 years ago)
• Default Branch: source
• Last Pushed: 2020-06-18T20:19:06.000Z (almost 6 years ago)
• Last Synced: 2025-03-17T13:52:26.502Z (over 1 year ago)
• Language: JavaScript
• Homepage:
• Size: 266 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# drex

Docusaurus template for my Open Source projects.

## Step 1: Clone this project and switch to a `source` branch

_(If you are not creating an organization page read the bottom note)_

## Step 2: Replace these template strings

Use your editor's **find all in path tool** to replace these template strings.

_All template strings to be replaced are in `SCREAMING_SNAKE_CASE` and start with `YOUR`._

_Check that no template strings remain after completing this list by searching for `YOUR` with your IDE._

- [ ] `YOUR_SOLVED_PROBLEM`: An uncapitalized phrase that describes what you project "makes it easy to" (no period)

  - Examples: clean your house, walk your dog, find your keys

- [ ] `YOUR_APP_TITLE`: A title for your app (It will be displayed throughout the site.)

  - Examples: Tinder, Discord, Amazon Games

- [ ] `YOUR_APP_TAGLINE`: A tagline for your app

  - Examples: Tinder for dogs, Clear your mind after a long day

- [ ] `YOUR_ORGANIZATION_NAME`: Your Github organization name

  - Examples: facebook, google

- [ ] `YOUR_GITHUB_PROJECT`: The Github project your documentation is for. (Not the repo the docs are hosted in)

  - Examples: react, create-react-app

## Step 3: Replace images

Replace: `website/static/img/favicon.ico` & `website/static/img/logo192.png`

## Step 4: Deploy to pages

Run the command: `sudo GIT_USER=YOUR_GITHUB_USERNAME USE_SSH=false npm run publish-gh-pages`

### If you want to deploy this to a repo's Github page (instead of an organization's page)

- Set `baseUrl` in config to `/YOUR_GITHUB_PROJECT/`

- Instead of moving to a `source` branch, stay on `master`.