https://github.com/oleksiyrudenko/docu2main

Documentation Central demo. Supports import from external projects
https://github.com/oleksiyrudenko/docu2main

Last synced: 17 days ago
JSON representation

Documentation Central demo. Supports import from external projects

• Host: GitHub
• URL: https://github.com/oleksiyrudenko/docu2main
• Owner: OleksiyRudenko
• Created: 2020-02-23T21:21:38.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-05T08:07:02.000Z (almost 2 years ago)
• Last Synced: 2024-10-29T20:33:49.640Z (2 months ago)
• Language: JavaScript
• Homepage: https://OleksiyRudenko.github.io/docu2main
• Size: 1.56 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 20
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Website

This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator.

The organization of the repo allows to import documents from other repos  

and keep imported content in sync.

### Installation

Install [git-subrepo](https://github.com/ingydotnet/git-subrepo#installation-instructions)

for it is required to keep imported content in sync with external source  

repositories.

```

$ yarn

```

### Local Development

```

$ yarn start

```

This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.

Whenever you want to sync up with remote sources of content stop

development server, run `yarn update` explicitly and then `yarn start`.

Unfortunately, on-the-fly update from external repos is not supported.

### Sync Up With External Sources

```

yarn update

```

This will invoke `git-subrepo` to update local copies of files

from external source repos `master` branches.

### Build

```

$ yarn build

```

This command updates imported content and generates static content  

into the `build` directory and can be served using any static contents  

hosting service.

### Deployment

```

$ GIT_USER= USE_SSH=true yarn deploy

```

If you are using GitHub pages for hosting, this command is a convenient  

way to build the website (having imported content updated)  

and push to the `gh-pages` branch.