Skip to content

Commit 3a3f344

Browse files
im-coder-lgim-coder-lg
authored
Merge branch 'main' into gitter-badge-1
2 parents d34b65c + e47e44e commit 3a3f344

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

48 files changed

+455
-2144
lines changed

‎.github/ISSUE_TEMPLATE/config.yml

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: Question
4+
url: https://github.com/im-coder-lg/comboser/discussions/new
5+
about: Ask the community for help on our GitHub Discussions board
6+
- name: Chat on Gitter
7+
about: Need immediate help or just want to talk? Join the Gitter!
8+
url: https://gitter.im/im-coder-lg/comboser

‎.gitignore

+5
Original file line numberDiff line numberDiff line change
@@ -1 +1,6 @@
11
dupe/*
2+
docs/*.html
3+
docs/docs/*.html
4+
docs/docs/assets/*.js
5+
docs/docs/assets/*.json
6+
docs/docs/assets/*.css

‎.gitpod.Dockerfile

+34
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,36 @@
11
FROM gitpod/workspace-full
22

3+
RUN echo hello people
4+
5+
# USER root
6+
7+
# RUN apt-get update && apt update
8+
9+
# && apt-get upgrade && apt upgrade
10+
11+
# Install Dropbear SSH server
12+
# RUN DEBIAN_FRONTEND=noninteractive apt-get install -yq \
13+
# dropbear \
14+
# && apt-get clean && rm -rf /var/lib/apt/lists/* /tmp/*
15+
16+
# # Install Chisel
17+
# RUN curl https://i.jpillora.com/chisel! | bash
18+
19+
# Install custom tools, runtime, etc.
20+
21+
# RUN bash .gitpod/gitpodDockerfile.sh
22+
23+
# RUN sudo apt-get install curl software-properties-common
24+
# RUN curl -sL https://deb.nodesource.com/setup_16.x | sudo bash -
25+
# RUN sudo apt-get install nodejs
26+
# RUN node --version
27+
28+
# RUN npm i -g @codedoc/cli
29+
# RUN echo "Codedoc Installed, now activating Gitpod..."
30+
31+
# RUN codedoc install
32+
# RUN echo "installed, activating served site"
33+
# RUN codedoc s
34+
# # testing code-server --link
35+
# RUN curl -fsSL https://code-server.dev/install.sh | sh
36+
# RUN code-server --link

‎.gitpod.yml

+21-4
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,33 @@ image:
55
# tasks for gitpod
66

77
tasks:
8-
- name: Dependencies
8+
- name: Jekyll Dependencies
99
command: |
10-
cd docs
10+
touch /tmp/.dep-lock
11+
cd site
1112
bundle install
1213
echo "Dependencies installed, starting server!"
14+
rm /tmp/.dep-lock
1315
exit
14-
- name: server
16+
- name: Jekyll server
17+
init: sleep 1 && while [ -f /tmp/.dep-lock ]; do sleep 1; done
1518
command: |
16-
cd docs
19+
cd site
1720
bundle exec jekyll serve
21+
22+
- name: CODEDOC Dependencies
23+
init: touch /tmp/.npm-lock
24+
command: |
25+
cd docs
26+
npm i -g @codedoc/cli
27+
codedoc install
28+
rm /tmp/.npm-lock
29+
30+
- name: CODEDOC Server
31+
init: sleep 1 && while [ -f /tmp/.dep-lock ]; do sleep 1; done
32+
command: |
33+
cd docs
34+
codedoc serve
1835
1936
2037
# - name: ngrok SSH Tunnel

‎README.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
[![Issue comments and project triage adding](https://github.com/im-coder-lg/comboser/actions/workflows/triager.yml/badge.svg)](https://github.com/im-coder-lg/comboser/actions/workflows/triager.yml)
2+
23
[![Releaser](https://github.com/im-coder-lg/comboser/actions/workflows/release.yml/badge.svg)](https://github.com/im-coder-lg/comboser/actions/workflows/release.yml) [![Join the chat at https://gitter.im/im-coder-lg/comboser](https://badges.gitter.im/im-coder-lg/comboser.svg)](https://gitter.im/im-coder-lg/comboser?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![Join the chat at https://gitter.im/combosercommunity/community](https://badges.gitter.im/combosercommunity/community.svg)](https://gitter.im/combosercommunity/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
4+
35
# Comboser
46
Ladies and Gentlemen, welcome to the (absurdly) cool repository of combination.
57

‎cheat-sheet(sites)/cheat-sheet.md

+242
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,242 @@
1+
# Markdown Cheat Sheet
2+
3+
Checkout `docs/md/docs/cheat-sheet.md` to see the markdown behind this page. Note that this is only
4+
a cheat-sheet, for a more complete list of specific markdown features of codedoc, check out the [official docs](https://codedoc.cc).
5+
6+
> :Buttons
7+
> > :Button label=Official Docs, url=https://codedoc.cc
8+
9+
<br>
10+
11+
> ⚠️⚠️
12+
> Do not forget to **REMOVE THIS PAGE** from your actual documentation!
13+
> ⚠️⚠️
14+
15+
<hr>
16+
17+
## Buttons
18+
19+
You can add buttons to your documents like this:
20+
21+
```md | some-doc.md
22+
> :Buttons
23+
> > :Button label=Click Me!, url=https://www.google.com
24+
>
25+
> > :Button label=Click Me Too!, url=https://www.github.com
26+
```
27+
28+
Which looks like this:
29+
30+
> :Buttons
31+
> > :Button label=Click Me!, url=https://www.google.com
32+
>
33+
> > :Button label=Click Me Too!, url=https://www.github.com
34+
35+
<br>
36+
37+
You can create icon buttons as well. By default material icons are used:
38+
39+
```md | some-doc.md
40+
> :Buttons
41+
> > :Button icon=true, label=android, url=https://www.google.com
42+
>
43+
> > :Button icon=true, label=code, url=https://www.github.com
44+
>
45+
> > :Button label=GitHub, url=https://www.github.com
46+
```
47+
48+
Which looks like this:
49+
50+
> :Buttons
51+
> > :Button icon=true, label=android, url=https://www.google.com
52+
>
53+
> > :Button icon=true, label=code, url=https://www.github.com
54+
>
55+
> > :Button label=GitHub, url=https://www.github.com
56+
57+
58+
<br>
59+
60+
You can add a copy button after a `code` element. This button would
61+
copy the contents of the `code` element.
62+
63+
```md | some-doc.md
64+
> :Buttons
65+
> > :CopyButton
66+
```
67+
> :Buttons
68+
> > :CopyButton
69+
70+
<hr>
71+
72+
## Tabs
73+
74+
You can add tabbed content like this:
75+
76+
```md | some-doc.md
77+
> :Tabs
78+
> > :Tab title=First Tab
79+
> >
80+
> > So this is the content of the first tab. Lets even have some code here:
81+
> > ```tsx | index.tsx
82+
> > import { Renderer } from '@connectv/html';
83+
> >
84+
> > const renderer = new Renderer();
85+
> > renderer.render(<div>Hellow World!</div>).on(document.body);
86+
> > ```
87+
>
88+
> > :Tab title=Second Tab
89+
> >
90+
> > Perhaps some other content here, maybe some more code?
91+
> >
92+
> > ```tsx | another.tsx
93+
> > import { Renderer } from '@connectv/html';
94+
> > import { timer } from 'rxjs';
95+
> >
96+
> > const renderer = new Renderer();
97+
> > renderer.render(<div>You have been here for {timer(0, 1000)} second(s).</div>)
98+
> > .on(document.body);
99+
> > ```
100+
```
101+
102+
<br>
103+
104+
> :Tabs
105+
> > :Tab title=First Tab
106+
> >
107+
> > So this is the content of the first tab. Lets even have some code here:
108+
> > ```tsx | index.tsx
109+
> > import { Renderer } from '@connectv/html';
110+
> >
111+
> > const renderer = new Renderer();
112+
> > renderer.render(<div>Hellow World!</div>).on(document.body);
113+
> > ```
114+
>
115+
> > :Tab title=Second Tab
116+
> >
117+
> > Perhaps some other content here, maybe some more code?
118+
> >
119+
> > ```tsx | another.tsx
120+
> > import { Renderer } from '@connectv/html';
121+
> > import { timer } from 'rxjs';
122+
> >
123+
> > const renderer = new Renderer();
124+
> > renderer.render(<div>You have been here for {timer(0, 1000)} second(s).</div>)
125+
> > .on(document.body);
126+
> > ```
127+
128+
<hr>
129+
130+
## Collapse
131+
132+
You can add collapsible sections like this:
133+
134+
```md | some-doc.md
135+
> :Collapse label=Collapsible content (click to open)
136+
>
137+
> This content is collapsed by default. You can write _any_ markdown syntax you would
138+
> like here as this is simply just an enhanced `block quote` element. You can even have lists:
139+
> - with multiple
140+
> - items and stuff
141+
>
142+
> > :Collapse label=Or nested collapsible content (click to open)
143+
> >
144+
> > > :Collapse label=Collapception
145+
> > >
146+
> > > To any depth that your heart might desire.
147+
>
148+
> This component is particularly useful in the table of contents (the left-side menu, activatable by
149+
> clicking on the hamburger menu in the footer), when you have got many documents and you would want to
150+
> neatly categorize them.
151+
```
152+
153+
<br>
154+
155+
> :Collapse label=Collapsible content (click to open)
156+
>
157+
> This content is collapsed by default. You can write _any_ markdown syntax you would
158+
> like here as this is simply just an enhanced `block quote` element. You can even have lists:
159+
> - with multiple
160+
> - items and stuff
161+
>
162+
> > :Collapse label=Or nested collapsible content (click to open)
163+
> >
164+
> > > :Collapse label=Collapception (click to open)
165+
> > >
166+
> > > To any depth that your heart might desire.
167+
>
168+
> This component is particularly useful in the table of contents (the left-side menu, activatable by
169+
> clicking on the hamburger menu in the footer), when you have got many documents and you would want to
170+
> neatly categorize them.
171+
172+
<hr>
173+
174+
## Dark/Light Content
175+
176+
If you have some content that differs in light mode vs in dark mode, you
177+
can use `DarkLight` component:
178+
179+
```md | some-doc.md
180+
> :DarkLight
181+
> > :InDark
182+
> >
183+
> > We are SO DARK! This content is only shown in dark-mode. Switch to light-mode
184+
> > by clicking on the dark/light toggle in the footer to see the light-mode specific content.
185+
>
186+
> > :InLight
187+
> >
188+
> > LIGHT bless you! This content is only shown in light-mode. Switch to dark-mode
189+
> > by clicking on the dark/light toggle in the footer to see the dark-mode specific content
190+
```
191+
192+
<br>
193+
194+
> :DarkLight
195+
> > :InDark
196+
> >
197+
> > We are SO DARK! This content is only shown in dark-mode. Switch to light-mode
198+
> > by clicking on the dark/light toggle in the footer to see the light-mode specific content.
199+
>
200+
> > :InLight
201+
> >
202+
> > LIGHT bless you! This content is only shown in light-mode. Switch to dark-mode
203+
> > by clicking on the dark/light toggle in the footer to see the dark-mode specific content
204+
205+
> If you are wondering why someone would **EVER** need such a thing, well I did. Because I wanted
206+
> to display different banner images based on dark-mode / light-mode:
207+
>
208+
> ```md
209+
> > :DarkLight
210+
> > > :InLight
211+
> > >
212+
> > > ![header](https://raw.githubusercontent.com/CONNECT-platform/codedoc/master/repo-banner.svg?sanitize=true)
213+
> >
214+
> > > :InDark
215+
> > >
216+
> > > ![header](https://raw.githubusercontent.com/CONNECT-platform/codedoc/master/repo-banner-dark.svg?sanitize=true)
217+
> ```
218+
>
219+
> > :DarkLight
220+
> > > :InLight
221+
> > >
222+
> > > ![header](https://raw.githubusercontent.com/CONNECT-platform/codedoc/master/repo-banner.svg?sanitize=true)
223+
> >
224+
> > > :InDark
225+
> > >
226+
> > > ![header](https://raw.githubusercontent.com/CONNECT-platform/codedoc/master/repo-banner-dark.svg?sanitize=true)
227+
>
228+
> Yeah I know the life of an idealist is never easy.
229+
230+
<hr>
231+
232+
## Navigation
233+
234+
You can add _previous_ and _next_ buttons to your pages like this:
235+
236+
```markdown
237+
> :ToCPrevNext
238+
```
239+
240+
Which would then look like this:
241+
242+
> :ToCPrevNext

0 commit comments

Comments
 (0)