Skip to content

Commit 2ebe44f

Browse files
committed
Add information about anchors
1 parent c884f85 commit 2ebe44f

File tree

1 file changed

+21
-7
lines changed

1 file changed

+21
-7
lines changed

src/contrib.md

Lines changed: 21 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,11 @@
22
<!--?imgroot &imgroot&-->
33
#How to Contribute
44

5-
At least at first stage we are going to collaborate via means of github.
5+
## General information
66

7-
Generated pages are placed at [http://e-maxx-eng.appspot.com](http://e-maxx-eng.appspot.com).
7+
We collaborate via means of github.
8+
9+
Generated pages are compiled and published at [http://e-maxx-eng.appspot.com](http://e-maxx-eng.appspot.com).
810

911
And sources (to which you may want to contribute) are [here](http://github.com/e-maxx-eng/e-maxx-eng/tree/master/src).
1012

@@ -26,11 +28,11 @@ Please kindly refer to manuals on using `git` and `github` anywhere over interne
2628
<iframe width="420" height="315" src="https://www.youtube.com/embed/TrBBw4J9X30" frameborder="0" allowfullscreen></iframe>
2729
</div>
2830

29-
###Your Authorship is Preserved
31+
##Your Authorship is Preserved
3032

3133
Some contributors add explicit links to their profiles at the bottom of the translated articles. However it is discouraged and simply not very convenient if the article was edited by several people. Every page has `Page Authors` link in its top - this link leads to the github commit history, so it is always easy to determine or prove the authorship (even of any single line). Just make sure that your GitHub profile (which is mentioned in history) provides enough information about you.
3234

33-
###Source format
35+
##Source format
3436

3537
We use [Markdown](https://daringfireball.net/projects/markdown) for source texts and
3638
convert them automatically to HTML.
@@ -44,11 +46,11 @@ And here is the formula in the separate block:
4446

4547
$$E = mc^{2}$$
4648

47-
###Some conventions
49+
##Some conventions
4850

4951
* We have agreed as of issue [#83](https://github.com/e-maxx-eng/e-maxx-eng/issues/83) to express binomial coefficients with `\binom{n}{k}` instead of `C_n^k`. The first one renders as $\binom{n}{k}$ and is a more universal convention. The second would render as $C_n^k$.
5052

51-
###Adding images
53+
##Adding images
5254

5355
Small images could be pushed along with texts to the [/img](https://github.com/e-maxx-eng/e-maxx-eng/tree/master/img) subfolder. Let them be in `PNG` format and less than `200kb`. Then you can refer to them inside the article with the tag:
5456

@@ -58,7 +60,19 @@ Here `my-image.png` should be your file name, while `&imgroot&` is some magic wh
5860

5961
Larger images should be posted to some image-hosting, like [PostImage](http://postimage.org) or [ImgUr](http://imgur.com/) - they will then give you the url to insert into the page.
6062

61-
###Page Template
63+
## Creating anchors and link to them
64+
65+
It is possible to generate HTLM anchors for sections of an article.
66+
E.g. the following generates a header and a named anchor.
67+
68+
## Implementation ## {#implementation}
69+
70+
And then link to it from the same or a different article:
71+
72+
For more detail read the [Implementation](#implementation).
73+
More infos in [Impl. of Segmenttree](./data_structures/segment_tree.html#implementation).
74+
75+
##Page Template
6276

6377
Template for the pages (the one which creates small violet header and footer, determines the layout of the text, includes css and js files) is now also stored in this repo, in [src/\_templates](https://github.com/e-maxx-eng/e-maxx-eng/tree/master/src/_templates) folder. So in case you find some bugs in it, or with the passing of time some new features may be needed in it - create PR to improve it. Note that for testing purposes the alternative template could be created and used for specific page with the inclusion of special comment as shown below:
6478

0 commit comments

Comments
 (0)