Skip to content

Commit

Permalink
Initial setup for docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jamesgeorge007 committed Jun 6, 2019
1 parent 88b25bb commit 438ff9a
Show file tree
Hide file tree
Showing 7 changed files with 11,829 additions and 2,487 deletions.
23 changes: 23 additions & 0 deletions docs/.vuepress/config.js
@@ -0,0 +1,23 @@

module.exports = {
title: 'teachcode',
description: 'Learn to code effectively',
head: [
['link', { rel: 'icon', href: 'images/logo.png' }]
],
themeConfig: {
repo: 'madlabsinc/teachcode',
nav: [
{text: 'Home', link: '/'},
{text: 'Guide', link: '/guide/'},
],
sidebar: {
'/guide/': [{
title: 'Guide'
}],
},
docsDir: 'docs',
editLinks: true,
editLinkText: 'Edit this page on GitHub'
}
}
Binary file added docs/.vuepress/public/images/logo.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.vuepress/public/images/teachcode.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
14 changes: 14 additions & 0 deletions docs/README.md
@@ -0,0 +1,14 @@
---
home: true
heroImage: images/teachcode.png
actionText: Get Started →
actionLink: /guide/
features:
- title: Learn Effectively
details: Solve simple challenges in the end familiarising with a new programming language.
- title: Resume Anytime
details: All completed tasks are pushed to a remote repository which makes it easier to track the user progress.
- title: Love The Terminal
details: Everything happens in the CLI environment which inturn takes away the fear from novices.
footer: MIT Licensed | Copyright © 2019-present MadHacks
---
16 changes: 16 additions & 0 deletions docs/guide/README.md
@@ -0,0 +1,16 @@
# teachcode

> Learn to code effectively.
## How it works

The user is provided with 30 tasks guiding them through the basic constructs of a preferred programming language. He/she gets a key to access the next task if the current task meets all the test cases. There is also the provision to revisit previously submitted tasks, but it can't be worked on again.

- Navigate to a directory of your choice and fire in teachcode init.
- Navigate to the teachcode-solutions directory.
- Copy and paste the command as instructed within the initial screen teachcode fetchtask {key}.
- Hurray :tada: you've got your first task.
- Write your solution within a file that is auto-created. For instance, task{task_number}.py for Python.
- teachcode submit submits the current solution and gives you the next key to proceed if your solution meets all the test cases.
- teachcode showkeys shows you all the keys.
- teachcode showcommands shows you all the commands available for reference.

0 comments on commit 438ff9a

Please sign in to comment.