Skip to content

kfcoding/gitcourse

Repository files navigation

Gitcourse

A react front framework which can present courses made by repositories.

Here is a sample as well as a guide to this project: gitcourse-guide

Getting start

Install

npm install gitcourse-core

Usage

import ReactDOM from 'react-dom';
import GitCourse from 'gitcourse-core';

ReactDOM.render(
  <GitCourse
    compact={false}
    repo={'${YOUR_GIT_REPOSITORY}'}
    dockerEndpoint={'${YOUR_DOCKER_ENDPOINT_SERVER_HOST}'}
    corsProxy={'${YOUR_GIT_CORS_PROXY}'}
  />
,
  document.getElementById('root')
);

If you have a general question about Gitcourse or some suggestions about Gitcourse we encourage you to post on our slack workspace . The maintainers and other community members are glad to talk with you.

About

Build elegant interactive product documentation with gitcourse

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published