-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathindex.html
More file actions
260 lines (255 loc) · 11.2 KB
/
Copy pathindex.html
File metadata and controls
260 lines (255 loc) · 11.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
<html>
<head>
<meta charset="utf-8">
<title>Matterwiki - A simple and beautiful wiki for teams</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="description" content="Page description. No longer than 155 characters."
/>
<!-- Twitter Card data -->
<meta name="twitter:card" content="Matterwiki is a free, simple, and beautiful internal wiki for collaboration">
<meta name="twitter:title" content="Matterwiki, a simple and beautiful wiki for teams">
<meta name="twitter:description" content="Matterwiki is a free, simple, and beautiful wiki for teams">
<meta name="twitter:creator" content="@nshntarora">
<meta name="twitter:image" content="https://github.com/Matterwiki/matterwiki.github.io/raw/master/assets/logo-header.png?raw=true">
<!-- Open Graph data -->
<meta property="og:title" content="Matterwiki, a simple and beautiful wiki for teams"
/>
<meta property="og:type" content="website" />
<meta property="og:url" content="http://matterwiki.com" />
<meta property="og:image" content="https://github.com/Matterwiki/matterwiki.github.io/raw/master/assets/logo-header.png?raw=true"
/>
<meta property="og:description" content="Matterwiki is a free, simple, and beautiful internal wiki for collaboration"
/>
<meta property="og:site_name" content="Matterwiki" />
<!-- css -->
<link rel="stylesheet" href="./assets/bootstrap.css" />
<link rel="stylesheet" href="./assets/style.css" />
<link rel="stylesheet" href="./assets/font-awesome.min.css" />
</head>
<body class="container-fluid">
<div class="row section center-align">
<div class="row">
<div class="col-md-12 col-sd-12">
<img src="./assets/logo.png" class="logo" />
<h1><b>A simple and beautiful wiki for teams</b></h1>
<h3 class="content-block">People use it to store documentation, notes, culture guidelines, employee onboarding content and everything they want to.
</h3>
<br/>
</div>
</div>
<div class="row">
<div class="col-md-4">
<a href="https://github.com/Matterwiki/Matterwiki/archive/master.zip" target="_blank"
class="btn btn-default btn-block btn-lg"><i class="fa fa-download" aria-hidden="true"></i> Download</a>
</div>
<div class="col-md-4">
<a href="https://github.com/Matterwiki/Matterwiki" target="_blank" class="btn btn-default btn-block btn-lg"><i class="fa fa-github" aria-hidden="true"></i> View on Github</a>
</div>
<div class="col-md-4">
<a href="https://matterwiki.herokuapp.com/" target="_blank" class="btn btn-default btn-block btn-lg"><i class="fa fa-laptop" aria-hidden="true"></i> Demo</a>
</div>
</div>
</div>
<div class="content">
<div class="row section center-align">
<div class="col-md-6 col-sd-12">
<i class="fa fa-question-circle fa-lg" aria-hidden="true"></i>
<h2><b>What is a wiki?</b></h2>
<p>A website or database developed collaboratively by a community of users,
allowing any user to add and edit content. Example: Wikipedia</p>
</div>
<div class="col-md-6 col-sd-12">
<i class="fa fa-heart fa-lg" aria-hidden="true"></i>
<h2><b>Why Matterwiki?</b></h2>
<p>Wiki softwares are too complicated for small teams. Matterwiki is just
that, a simple wiki for teams to store and collaborate on knowledge.</p>
</div>
</div>
<div class="row section center-align">
<i class="fa fa-book fa-lg" aria-hidden="true"></i>
<h2><b>Why do you need a wiki?</b></h2>
<div class="content-block center-align">
<p>
As your company grows it becomes difficult to keep track of all the knowledge
in your team. It is difficult to communicate every detail about company
policies to new team members. Things get lost in Slack channels. It
becomes difficult to keep things in context.
</p>
<p>
A wiki helps you keep track of all this information. Every article is filed
under a topic to keep things organised among departments. Everything
is transparent, <i>who</i> made <i>what</i> changes to <i>which</i> document and <i>when</i>.
</p>
</div>
</div>
<div class="row section center-align">
<i class="fa fa-align-left fa-lg" aria-hidden="true"></i>
<h2><b>Features a Simple WYSIWYG Editor</b></h2>
<div class="content-block center-align">
<p>
Unlike traditional wiki softwares,
<br/> Matterwiki uses a simple WYSIWYG editor. That means,
<br/> No complex formatting or structure to follow.
<br/> The editing environment you're comfortable in.
<br/>
</p>
<p>WYSIWYG = What you see is what you get.</p>
</div>
</div>
<div class="row section image-section center-align">
<i class="fa fa-desktop fa-lg" aria-hidden="true"></i>
<h2><b>Screenshots</b></h2>
<div class="center-align">
<p>
<i>Simple and Beautiful</i>, the two qualities we maintain on every
screen.
</p>
<div class="image-grid">
<div class="row">
<div class="col-md-6">
<img src="./assets/screenshot1.png">
<p>Browse Articles</p>
</div>
<div class="col-md-6">
<img src="./assets/screenshot2.png">
<p>Create or Edit Articles</p>
</div>
</div>
<hr/>
<div class="row">
<div class="col-md-6">
<img src="./assets/screenshot3.png">
<p>Read Articles</p>
</div>
<div class="col-md-6">
<img src="./assets/screenshot4.png">
<p>Browse Revisions</p>
</div>
</div>
</div>
</div>
</div>
<div class="row section image-section center-align">
<i class="fa fa-terminal fa-lg" aria-hidden="true"></i>
<h2><b>Under the hood</b></h2>
<div class="center-align">
<p>Matterwiki uses a Node.js API with a React.js front-end and Sqlite3
for the database.</p>
<img src="./assets/technologies.png">
<p>As the app is built atop a JSON API, it is simple to integrate your
Wiki with your mobile app or blog. For more, read the <a href="https://github.com/Matterwiki/Matterwiki/blob/master/API.md">API documentation</a>.</p>
</div>
</div>
<div class="row section center-align">
<i class="fa fa-wrench fa-lg" aria-hidden="true"></i>
<h2><b>Setup Instructions</b></h2>
<div class="content-block left-align">
<p>
You need to have <span class="code">Node</span> and <span class="code">npm</span> installed on your system.
<ol>
<li>Clone this repository <span class="code">git clone http://github.com/matterwiki/matterwiki</span>
</li>
<li>Run <span class="code">npm install</span>
</li>
<li>Edit <span class="code">config.js</span> (present in the project
root) and change the <span class="code">auth_secret</span> value
with any secret phrase.
<br/>NOTE: This phrase will be used to encode and decode your access
tokens. Keep it safe and private</li>
<li>run <span class="code">npm run build</span>
</li>
<li>At this point, running this with a process manager like PM2 would
ensure that this is a background process and doesn't die out. A
sample way of starting the app would be:</li>
<span class="code">NODE_ENV=production PORT=8000 pm2 start index.js --name "matterwiki"</span>
<br/>
<i>Some points to note here :<br/>
NODE_ENV could take one of these two values, dev or production.<br/>
PORT is optional. If it is not specified, then 5000 would be used.<br/></i> However, if you do not need all this, running <span class="code">npm start</span> should boot up the production build of the app.</li>
<li>Head to <span class="code">yoururl.com/#/setup</span> and create
the Admin account.</li>
<li>Replace <span class="code">yoururl.com</span> with your URL. If you're
running locally, replace with localhost:5000</li>
<li>Login with your new admin account and head to the Admin dashboard.</li>
<li>Create topics and add users to your Wiki.</li>
</ol>
</p>
<p>Docker instructions are available <a href="http://github.com/matterwiki/matterwiki">here</a>.</p>
</div>
</div>
<div class="row section center-align content-block">
<div class="col-md-12 col-sd-12">
<i class='fa fa-envelope'></i>
<br/>
<h2><b>Subscribe for updates</b></h2>
</div>
<div class="col-md-12 col-sd-12 subscription-form">
<div id="mc_embed_signup">
<form action="//matterwiki.us15.list-manage.com/subscribe/post?u=631f9da4f4be34f69acee4756&id=600882a015"
method="post" id="mc-embedded-subscribe-form" name="mc-embedded-subscribe-form"
class="validate" target="_blank" novalidate>
<div id="mc_embed_signup_scroll" class="row">
<div class="col-md-8 col-sd-12">
<div class="mc-field-group">
<input type="email" value="" name="EMAIL" class="required email form-control"
id="mce-EMAIL" placeholder="Enter your email">
</div>
<div id="mce-responses" class="clear">
<div class="response" id="mce-error-response" style="display:none"></div>
<div class="response" id="mce-success-response" style="display:none"></div>
</div>
</div>
<div class="col-md-4 col-sd-12">
<!-- real people should not fill this in and expect good things - do not remove this or risk form bot signups-->
<div style="position: absolute; left: -5000px;" aria-hidden="true">
<input type="text" name="b_631f9da4f4be34f69acee4756_600882a015" tabindex="-1"
value="">
</div>
<div class="clear">
<input type="submit" value="Subscribe" name="subscribe" id="mc-embedded-subscribe"
class="button btn btn-default btn-block btn-lg">
</div>
</div>
</div>
</form>
</div>
</div>
<p class="help-block">No spam. Only one email a month. Details about latest updates and features.</p>
</div>
<div class="row center-align">
<img src="./assets/beer.png" class="beer-icon">
<br/>
<br/>
<p>Released under MIT license
<br/>
<a class="github-button" href="https://github.com/Matterwiki/Matterwiki/fork"
data-icon="octicon-repo-forked" data-style="mega" data-count-href="/Matterwiki/Matterwiki/network"
data-count-api="/repos/Matterwiki/Matterwiki#forks_count" data-count-aria-label="# forks on GitHub"
aria-label="Fork Matterwiki/Matterwiki on GitHub">Fork</a>
<a class="github-button" href="https://github.com/Matterwiki/Matterwiki"
data-icon="octicon-star" data-style="mega" data-count-href="/Matterwiki/Matterwiki/stargazers"
data-count-api="/repos/Matterwiki/Matterwiki#stargazers_count" data-count-aria-label="# stargazers on GitHub"
aria-label="Star Matterwiki/Matterwiki on GitHub">Star</a>
</p>
</div>
</div>
<link href="https://fonts.googleapis.com/css?family=Muli" rel="stylesheet">
<script async defer src="https://buttons.github.io/buttons.js"></script>
<script>
(function(i, s, o, g, r, a, m) {
i['GoogleAnalyticsObject'] = r;
i[r] = i[r] || function() {
(i[r].q = i[r].q || []).push(arguments)
}, i[r].l = 1 * new Date();
a = s.createElement(o),
m = s.getElementsByTagName(o)[0];
a.async = 1;
a.src = g;
m.parentNode.insertBefore(a, m)
})(window, document, 'script',
'https://www.google-analytics.com/analytics.js', 'ga');
ga('create', 'UA-89975156-1', 'auto');
ga('send', 'pageview');
</script>
</body>
</html>