Skip to content

Commit e270a67

Browse files
author
Andrii Afanasiev
committed
update: readme
1 parent 0357350 commit e270a67

File tree

1 file changed

+34
-3
lines changed

1 file changed

+34
-3
lines changed

README.md

Lines changed: 34 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,46 @@ Dou to bad sync with composer there are some steps
99
4. Enable extension with name ```PHPBB Code Highlight```
1010
5. [Optional] Navigate to the ACP ```Extensions -> PPHPBB Code Highlight -> Settings``` and setup list of languages and theme.
1111

12+
###### NOTE
13+
Enabling of all languages will cause performance issues on clients side, because each langauge is loading as separate JS.
14+
So, if You are still needed to have all languages, then it will be nice to have:
15+
1. HTTP2 on server
16+
2. Static-Domain
17+
3. CDN
18+
19+
## How to use in posts
20+
To highlight code in post use new PHPBB tag [syntax]:
21+
```ini
22+
[syntax=cpp]
23+
#include <tuple>
24+
25+
std::tuple<int, bool, float> foo()
26+
{
27+
return std::make_tuple(128, true, 1.5f);
28+
}
29+
30+
int main()
31+
{
32+
std::tuple<int, bool, float> result = foo();
33+
int value = std::get<0>(result);
34+
int obj1;
35+
bool obj2;
36+
float obj3;
37+
std::tie(obj1, obj2, obj3) = foo();
38+
}
39+
[/syntax]
40+
```
41+
1242
## Links
1343
- [PHPBB Dev Docs](https://area51.phpbb.com/docs/dev/)
1444
- [HighlightJS](https://highlightjs.org/)
1545
- [Currently Used Here](https://forum.cryengine.com/)
1646
- [PHPBB Events list](https://wiki.phpbb.com/Event_List)
1747

18-
## Help needed
19-
1. Advise how to proper store dependency from [HighlightJS repo](https://github.com/isagalaev/highlight.js)
20-
2. Advise how to wrap PHPBB extension with composer
48+
## TODO
49+
1. Proper store dependency from [HighlightJS repo](https://github.com/isagalaev/highlight.js)
50+
2. Wrap PHPBB extension with composer
51+
3. Write tests
2152

2253
## Thank You
2354
Big thanks for community

0 commit comments

Comments
 (0)