Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

Commit d274898

Browse files
Merge pull request #37 from acmucsd/update-template-comments
Change comment style of templates
2 parents df1f6b4 + 79cd5f0 commit d274898

File tree

3 files changed

+74
-74
lines changed

3 files changed

+74
-74
lines changed

‎internal/templates/single-workshop/README.md

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -3,29 +3,29 @@ title: "Title of Workshop"
33
description: "Short description of the workshop."
44
---
55

6-
<!--
6+
{/*
77
The above is REQUIRED YAML Frontmatter so the README can be rendered
88
in the ACM Wiki. DO NOT move the frontmatter from its location.
99
It is also ESSENTIAL to fill out; make it good!
10-
-->
10+
*/}
1111

12-
<!--
12+
{/*
1313
If you have any questions about this template, feel free to ask
1414
your Director for help!
15-
-->
15+
*/}
1616

17-
<!--
17+
{/*
1818
SECTION: Header
1919
---------
2020
Request new headers from you Director to fit your workshop!
21-
-->
21+
*/}
2222

2323
![Alt Text (This should be your workshop title written so it's screenreader-compatible)](./figures/Default_Header_Light.png#gh-light-mode-only)
2424
![Alt Text (This should be your workshop title written so it's screenreader-compatible)](./figures/Default_Header_Dark.png#gh-dark-mode-only)
2525

26-
The official ACM AI <!-- Your Workshop Name --> repository.
26+
The official ACM AI {/* Your Workshop Name */} repository.
2727

28-
<!--
28+
{/*
2929
Mandatory Sections:
3030
- File Directory Structure
3131
- Workshop Recording
@@ -43,21 +43,21 @@ The official ACM AI <!-- Your Workshop Name --> repository.
4343
- Separate from 'Resources' to distinguish between inspiration and
4444
things like datasets used in a notebook
4545
- Anything else you'd like, but try not to be redundant!
46-
-->
46+
*/}
4747

48-
<!--
48+
{/*
4949
SECTION: Workshop Video
5050
---------
5151
Most, if not all, workshops should have recordings. Once the recording
5252
is posted to the ACMUCSD YT channel (https://www.youtube.com/channel/UCyjPATFqc3FwOiuqJ2UG1Eg),
5353
replace the text with an <img> element.
54-
-->
54+
*/}
5555

5656
# 1. Workshop Video
5757

5858
*Will be added as soon as uploaded to YouTube*
5959

60-
<!--
60+
{/*
6161
<div align="center">
6262
<a href="YT Video Link">
6363
<img
@@ -67,13 +67,13 @@ The official ACM AI <!-- Your Workshop Name --> repository.
6767
/>
6868
</a>
6969
</div>
70-
-->
70+
*/}
7171

72-
<!--
72+
{/*
7373
SECTION: File Directory Structure
7474
---------
7575
Write out your File Directory Structure below (make sure it's up-to-date)
76-
-->
76+
*/}
7777

7878
# 2. File Directory Structure
7979

@@ -86,42 +86,42 @@ nlp-series
8686
| -- README.md
8787
```
8888

89-
<!--
89+
{/*
9090
SECTION: Getting Started
9191
---------
9292
Brief description of your workshop here
93-
-->
93+
*/}
9494

9595
# 3. Getting Started
9696

97-
<!--
97+
{/*
9898
You can write something up or use the marketing description.
99-
-->
99+
*/}
100100

101101

102-
<!--
102+
{/*
103103
SECTION: Resources
104104
---------
105105
Make sure to cite everything you use, whether directly or for inspiration!
106-
-->
106+
*/}
107107

108108
# 4. Resources
109109

110-
<!--
110+
{/*
111111
List all your resources below; DO NOT skimp on this part!
112-
-->
112+
*/}
113113

114114
- [*Pale Blue Dot*](https://www.youtube.com/watch?v=wupToqz1e2g&ab_channel=carlsagandotcom) by Carl Sagan from carlsagandot.com on YouTube
115115

116116

117-
<!--
117+
{/*
118118
SECTION: Author Info
119119
---------
120120
Make sure to give yourself credit for your work by listing yourself and
121121
your partners below! Add your LinkedIn and GitHub!
122-
-->
122+
*/}
123123

124124
# 5. Author Info
125125

126-
- Person One: [LinkedIn](<!-- LinkedIn link -->) | [GitHub](<!-- GitHub link -->)
127-
- Person Two: [LinkedIn](<!-- LinkedIn link -->) | [GitHub](<!-- GitHub link -->)
126+
- Person One: [LinkedIn]({/* LinkedIn link */}) | [GitHub]({/* GitHub link */})
127+
- Person Two: [LinkedIn]({/* LinkedIn link */}) | [GitHub]({/* GitHub link */})

‎internal/templates/workshop-series/README.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -3,30 +3,30 @@ title: "Title of Series"
33
description: "Short description of the series."
44
---
55

6-
<!--
6+
{/*
77
The above is REQUIRED YAML Frontmatter so the README can be rendered
88
in the ACM Wiki. DO NOT move the frontmatter from its location.
99
It is also ESSENTIAL to fill out; make it good!
10-
-->
10+
*/}
1111

12-
<!--
12+
{/*
1313
If you have any questions about this template, feel free to ask
1414
your Director for help!
15-
-->
15+
*/}
1616

1717

18-
<!--
18+
{/*
1919
SECTION: Header
2020
---------
2121
Request new headers from you Director to fit your workshop!
22-
-->
22+
*/}
2323

2424
![Alt Text (This should be your workshop title written so it's screenreader-compatible)](./Default_Main_Header_Light.png#gh-light-mode-only)
2525
![Alt Text (This should be your workshop title written so it's screenreader-compatible)](./Default_Main_Header_Dark.png#gh-dark-mode-only)
2626

27-
The official ACM AI <!-- Your Series Name --> repository.
27+
The official ACM AI {/* Your Series Name */} repository.
2828

29-
<!--
29+
{/*
3030
SECTION: Table of Contents
3131
---------
3232
Mandatory Sections:
@@ -42,13 +42,13 @@ The official ACM AI <!-- Your Series Name --> repository.
4242
- Separate from 'Resources' to distinguish between inspiration and
4343
things like datasets used in a notebook
4444
- Anything else you'd like, but try not to be redundant!
45-
-->
45+
*/}
4646

47-
<!--
47+
{/*
4848
SECTION: File Directory Structure
4949
---------
5050
Write out your File Directory Structure below (make sure it's up-to-date)
51-
-->
51+
*/}
5252

5353
# 1. File Directory Structure
5454

@@ -63,46 +63,46 @@ nlp-series
6363
| -- README.md
6464
```
6565

66-
<!--
66+
{/*
6767
SECTION: Getting Started
6868
---------
6969
Brief description of your workshop here
70-
-->
70+
*/}
7171

7272
# 2. Getting Started
7373

7474
## 2.1 Workshop 1
7575

76-
<!--
76+
{/*
7777
You can write something up for each worksop or use their marketing descriptions.
78-
-->
78+
*/}
7979

8080
This workshop is so great guys trust me.
8181

82-
<!--
82+
{/*
8383
SECTION: Resources
8484
---------
8585
Make sure to cite everything you use, whether directly or for inspiration!
86-
-->
86+
*/}
8787

8888
# 3. Resources
8989

9090
## 3.1 Workshop 1
9191

92-
<!--
92+
{/*
9393
List all your resources for each workshop; DO NOT skimp on this part!
94-
-->
94+
*/}
9595

9696
- [*Pale Blue Dot*](https://www.youtube.com/watch?v=wupToqz1e2g&ab_channel=carlsagandotcom) by Carl Sagan from carlsagandotcom on YouTube
9797

98-
<!--
98+
{/*
9999
SECTION: Author Info
100100
---------
101101
Make sure to give yourself credit for your work by listing yourself and
102102
your partners below! Add your LinkedIn and GitHub!
103-
-->
103+
*/}
104104

105105
# 4. Author Info
106106

107-
- Person One: [LinkedIn](<!-- LinkedIn link -->) | [GitHub](<!-- GitHub link -->)
108-
- Person Two: [LinkedIn](<!-- LinkedIn link -->) | [GitHub](<!-- GitHub link -->)
107+
- Person One: [LinkedIn]({/* LinkedIn link */}) | [GitHub]({/* GitHub link */})
108+
- Person Two: [LinkedIn]({/* LinkedIn link */}) | [GitHub]({/* GitHub link */})

‎internal/templates/workshop-series/workshop-1/README.md

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -3,30 +3,30 @@ title: "Title of Workshop 1"
33
description: "Short description of Workshop 1."
44
---
55

6-
<!--
6+
{/*
77
The above is REQUIRED YAML Frontmatter so the README can be rendered
88
in the ACM Wiki. DO NOT move the frontmatter from its location.
99
It is also ESSENTIAL to fill out; make it good!
10-
-->
10+
*/}
1111

12-
<!--
12+
{/*
1313
If you have any questions about this template, feel free to ask
1414
your Director for help!
15-
-->
15+
*/}
1616

1717

18-
<!--
18+
{/*
1919
SECTION: Header
2020
---------
2121
Request new headers from you Director to fit your workshop!
22-
-->
22+
*/}
2323

2424
![Alt Text (This should be your workshop title written so it's screenreader-compatible)](./figures/DefaultW1_Header_Light.png#gh-light-mode-only)
2525
![Alt Text (This should be your workshop title written so it's screenreader-compatible)](./figures/DefaultW1_Header_Dark.png#gh-dark-mode-only)
2626

27-
The official ACM AI <!-- Your Series Name --> - Workshop <!-- # --> repository.
27+
The official ACM AI {/* Your Series Name */} - Workshop {/*# */} repository.
2828

29-
<!--
29+
{/*
3030
SECTION: Table of Contents
3131
---------
3232
Mandatory Sections:
@@ -46,20 +46,20 @@ The official ACM AI <!-- Your Series Name --> - Workshop <!-- # --> repository.
4646
- Anything else you'd like, but try not to be redundant!
4747
- Make sure it's not already in the main series README or
4848
another section
49-
-->
49+
*/}
5050

51-
<!--
51+
{/*
5252
SECTION: Workshop Video
5353
---------
5454
Most, if not all, workshops should have recordings. Once the recording
5555
is posted to the ACMUCSD YT channel (https://www.youtube.com/channel/UCyjPATFqc3FwOiuqJ2UG1Eg), replace the text with an <img> element.
56-
-->
56+
*/}
5757

5858
# 1. Workshop Video
5959

6060
*Will be added as soon as uploaded to YouTube*
6161

62-
<!--
62+
{/*
6363
<div align="center">
6464
<a href="YT Video Link">
6565
<img
@@ -69,13 +69,13 @@ The official ACM AI <!-- Your Series Name --> - Workshop <!-- # --> repository.
6969
/>
7070
</a>
7171
</div>
72-
-->
72+
*/}
7373

74-
<!--
74+
{/*
7575
SECTION: File Directory Structure
7676
---------
7777
Write out your File Directory Structure below (make sure it's up-to-date)
78-
-->
78+
*/}
7979

8080
# 2. File Directory Structure
8181

@@ -88,24 +88,24 @@ nlp-series
8888
| -- README.md
8989
```
9090

91-
<!--
91+
{/*
9292
SECTION: Getting Started
9393
---------
9494
Brief description of your workshop here
95-
-->
95+
*/}
9696

9797
# 3. Getting Started
9898

99-
<!--
99+
{/*
100100
You can write something up or use the marketing description.
101-
-->
101+
*/}
102102

103103
This workshop is so great guys trust me.
104104

105-
Workshop <!-- # --> consists of <!-- however many you choose --> components:
106-
- [Notebook](<!-- Local Path to Notebook -->) with completed code and explanations.
107-
- [Summary Graphic](<!-- Local Path to Summary Graphic -->) to summarize key points of the workshop.
105+
Workshop {/*# */} consists of {/* however many you choose */} components:
106+
- [Notebook]({/* Local Path to Notebook */}) with completed code and explanations.
107+
- [Summary Graphic]({/* Local Path to Summary Graphic */}) to summarize key points of the workshop.
108108

109-
<!--
109+
{/*
110110
Note: The above list will depend on your specific workshop.
111-
-->
111+
*/}

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /