Knowledge

AsciiDoc

Source 📝

819: 1110: 418: 262: 194: 25: 1151: 577: 909: 1026: 778:– (deprecated) a documentation system built on Asciidoctor for people who have a lot of docs to maintain and republish on a regular basis. 662:
is an on-line encyclopedia, available in English and *many* other languages. == Software You can install 'package-name' using the
1498: 1335: 806:– DocBook Authoring and Publishing Suite (DAPS) is command-line software to publish DocBook & AsciiDoc as HTML, PDF, and EPUB. 1144: 1468: 1305: 837: 1503: 934: 1378: 1004: 824: 1137: 89: 1479: 1355: 613: 108: 61: 645:
The following shows text using AsciiDoc mark-up, and a rendering similar to that produced by an AsciiDoc processor:
473: 317: 1345: 68: 46: 298: 1320: 431: 275: 75: 842: 605: 593: 581: 454: 409: 253: 1383: 982: 57: 42: 913: 417: 261: 1458: 1438: 1373: 1285: 1176: 884: 1408: 1084: 862: 478: 322: 35: 1034: 958: 1208: 1070: 584:
to convert plain-text, ‘human readable’ files to commonly used published document formats.
1120: 8: 1423: 1109: 634: 193: 127: 82: 983:"AsciiDoc, powered by Asciidoctor, returns to GitHub and its 5+ million repositories" 785: 620: 877: 855: 1413: 1239: 1196: 485: 461: 329: 305: 170: 1181: 1160: 1056: 530: 996: 775: 1191: 627: 516: 466: 310: 1492: 1325: 1186: 666:
command: gem install package-name == Hardware Metals commonly used include:
437: 1129: 1203: 1168: 281: 560:, slide presentations, etc. Common file extensions for AsciiDoc files are 781: 768:– a multi-repository documentation site generator for tech writers using 534: 490: 633:
The AsciiDoc format is currently under standardization procedure by the
1270: 527: 374: 364: 218: 208: 139: 1300: 596:
implementation called ‘Asciidoctor’, released in 2013, is in use by
24: 1453: 1403: 1398: 1388: 1365: 1360: 1254: 832: 803: 1443: 1340: 1315: 1295: 553: 520: 345: 1433: 1428: 1350: 1290: 1280: 1234: 601: 597: 557: 334: 1463: 1448: 1393: 1330: 1249: 1229: 609: 580:, who published tools (‘asciidoc’ and ‘a2x’), written in the 541:
or any other format supported by a DocBook tool-chain, i.e.
1418: 1310: 1224: 1115: 797: 550: 538: 501: 791: 623:'s books and e-books are authored using AsciiDoc mark-up. 1244: 769: 546: 542: 533:
conventions. AsciiDoc documents can be created using any
523: 1103: 1027:"AsciiDoc 101 (chapter 4 of Getting Started with Atlas)" 186: 765: 1121:
Using AsciiDoc and Asciidoctor to write documentation
708:
is an on-line encyclopedia, available in English and
814: 49:. Unsourced material may be challenged and removed. 1490: 800:– AsciiDocLIVE is a free online AsciiDoc editor. 604:. This implementation is also available in the 959:"AsciiDoc Recommended Practices | Asciidoctor" 1159: 1145: 519:document format, semantically equivalent to 223:Matthew Peveler, Dan Allen, Michel Krämer, 1152: 1138: 1108: 564:(as encouraged by AsciiDoc's creator) and 416: 260: 192: 794:– AsciiDoc Book Editor based on JavaFX 8. 705: 109:Learn how and when to remove this message 1491: 838:Comparison of documentation generators 784:– a static site generator inspired by 630:documentation is written in AsciiDoc. 1133: 935:"AsciiDoc Frequently Asked Questions" 904: 902: 825:Free and open-source software portal 47:adding citations to reliable sources 18: 13: 1499:Free software programmed in Python 14: 1515: 1480:List of document markup languages 1095: 899: 537:and read “as-is”, or rendered to 1085:"AsciiDoc Working Group Charter" 1033:. O'Reilly Media. Archived from 817: 576:AsciiDoc was created in 2002 by 23: 1077: 1063: 1007:from the original on 2019-07-22 34:needs additional citations for 1049: 1019: 989: 975: 951: 927: 739:Metals commonly used include: 587: 16:Human-readable document format 1: 848: 1504:Lightweight markup languages 7: 843:Lightweight markup language 810: 582:Python programming language 156:; 22 years ago 10: 1520: 640: 571: 1477: 1263: 1217: 1167: 1161:Document markup languages 732:gem install package-name 616:ecosystem using Opal.js. 496: 484: 472: 460: 450: 430: 426: 408: 404: 386: 373: 363: 340: 328: 316: 304: 294: 274: 270: 252: 248: 230: 217: 207: 181: 168: 150: 145:text/asciidoc, text/plain 138: 126: 1177:Compound Document Format 1116:https://asciidoctor.org/ 759: 656: 379:Dan Allen, Sarah White, 140:Internet media type 479:Documentation generator 323:Documentation generator 1123:- An AsciiDoc Tutorial 658:= My Article J. Smith 392:; 11 years ago 236:; 21 years ago 234:November 25, 2002 133:.adoc, .asciidoc, .txt 689:HTML-rendered result 660:https://wikipedia.org 651:AsciiDoc source text 390:January 30, 2013 122:AsciiDoc file format 43:improve this article 1071:"AsciiDoc Language" 360: 204: 128:Filename extensions 123: 1037:on 14 October 2017 1031:Author Welcome Kit 635:Eclipse Foundation 365:Original author(s) 358: 209:Original author(s) 202: 121: 1486: 1485: 757: 756: 712:other languages. 684: 683: 510: 509: 356: 355: 265:/ 17 July 2024 200: 199: 119: 118: 111: 93: 1511: 1414:ReStructuredText 1197:WordprocessingML 1154: 1147: 1140: 1131: 1130: 1112: 1107: 1106: 1104:Official website 1089: 1088: 1081: 1075: 1074: 1067: 1061: 1060: 1053: 1047: 1046: 1044: 1042: 1023: 1017: 1016: 1014: 1012: 1001:GitLab User Docs 993: 987: 986: 979: 973: 972: 970: 969: 955: 949: 948: 946: 945: 931: 925: 924: 922: 921: 912:. Archived from 906: 897: 896: 894: 892: 885:"Release 2.0.23" 881: 875: 874: 872: 870: 863:"Release 10.2.1" 859: 827: 822: 821: 820: 729: 720:You can install 713: 686: 685: 677: 673: 669: 665: 661: 648: 647: 608:ecosystem using 567: 563: 506: 503: 462:Operating system 446: 443: 441: 439: 421:/ 17 May 2024 420: 400: 398: 393: 382: 361: 357: 352: 349: 347: 306:Operating system 290: 287: 285: 283: 264: 244: 242: 237: 226: 205: 201: 196: 191: 188: 174: 164: 162: 157: 124: 120: 114: 107: 103: 100: 94: 92: 51: 27: 19: 1519: 1518: 1514: 1513: 1512: 1510: 1509: 1508: 1489: 1488: 1487: 1482: 1473: 1259: 1213: 1163: 1158: 1127: 1102: 1101: 1098: 1093: 1092: 1083: 1082: 1078: 1073:. 27 July 2020. 1069: 1068: 1064: 1055: 1054: 1050: 1040: 1038: 1025: 1024: 1020: 1010: 1008: 995: 994: 990: 981: 980: 976: 967: 965: 963:asciidoctor.org 957: 956: 952: 943: 941: 933: 932: 928: 919: 917: 908: 907: 900: 890: 888: 883: 882: 878: 868: 866: 861: 860: 856: 851: 823: 818: 816: 813: 762: 753: 752: 736: 733: 727: 719: 717: 704: 697: 680: 679: 675: 671: 667: 663: 659: 643: 590: 574: 565: 561: 500: 436: 422: 396: 394: 391: 387:Initial release 380: 344: 280: 266: 240: 238: 235: 231:Initial release 224: 185: 169: 160: 158: 155: 151:Initial release 146: 134: 115: 104: 98: 95: 52: 50: 40: 28: 17: 12: 11: 5: 1517: 1507: 1506: 1501: 1484: 1483: 1478: 1475: 1474: 1472: 1471: 1466: 1461: 1456: 1451: 1446: 1441: 1436: 1431: 1426: 1421: 1416: 1411: 1406: 1401: 1396: 1391: 1386: 1381: 1376: 1371: 1368: 1363: 1358: 1353: 1348: 1343: 1338: 1333: 1328: 1323: 1318: 1313: 1308: 1303: 1298: 1293: 1288: 1283: 1278: 1273: 1267: 1265: 1261: 1260: 1258: 1257: 1252: 1247: 1242: 1237: 1232: 1227: 1221: 1219: 1215: 1214: 1212: 1211: 1206: 1201: 1200: 1199: 1194: 1192:PresentationML 1189: 1179: 1173: 1171: 1165: 1164: 1157: 1156: 1149: 1142: 1134: 1125: 1124: 1118: 1113: 1097: 1096:External links 1094: 1091: 1090: 1076: 1062: 1048: 1018: 988: 974: 950: 926: 898: 876: 865:. 17 July 2024 853: 852: 850: 847: 846: 845: 840: 835: 829: 828: 812: 809: 808: 807: 801: 795: 789: 779: 773: 761: 758: 755: 754: 751: 750: 747: 744: 737: 734: 731: 725: 715: 695: 694: 691: 690: 682: 681: 657: 653: 652: 642: 639: 621:O'Reilly Media 589: 586: 578:Stuart Rackham 573: 570: 517:human-readable 508: 507: 498: 494: 493: 488: 482: 481: 476: 470: 469: 467:Cross-platform 464: 458: 457: 452: 448: 447: 434: 428: 427: 424: 423: 414: 412: 410:Stable release 406: 405: 402: 401: 388: 384: 383: 377: 371: 370: 367: 354: 353: 342: 338: 337: 332: 326: 325: 320: 314: 313: 311:Cross-platform 308: 302: 301: 296: 292: 291: 278: 272: 271: 268: 267: 258: 256: 254:Stable release 250: 249: 246: 245: 232: 228: 227: 221: 215: 214: 213:Stuart Rackham 211: 198: 197: 183: 179: 178: 175: 166: 165: 152: 148: 147: 144: 142: 136: 135: 132: 130: 117: 116: 31: 29: 22: 15: 9: 6: 4: 3: 2: 1516: 1505: 1502: 1500: 1497: 1496: 1494: 1481: 1476: 1470: 1467: 1465: 1462: 1460: 1457: 1455: 1452: 1450: 1447: 1445: 1442: 1440: 1437: 1435: 1432: 1430: 1427: 1425: 1422: 1420: 1417: 1415: 1412: 1410: 1407: 1405: 1402: 1400: 1397: 1395: 1392: 1390: 1387: 1385: 1382: 1380: 1377: 1375: 1372: 1369: 1367: 1364: 1362: 1359: 1357: 1354: 1352: 1349: 1347: 1344: 1342: 1339: 1337: 1334: 1332: 1329: 1327: 1326:Enriched text 1324: 1322: 1319: 1317: 1314: 1312: 1309: 1307: 1304: 1302: 1299: 1297: 1294: 1292: 1289: 1287: 1284: 1282: 1279: 1277: 1274: 1272: 1269: 1268: 1266: 1262: 1256: 1253: 1251: 1248: 1246: 1243: 1241: 1238: 1236: 1233: 1231: 1228: 1226: 1223: 1222: 1220: 1216: 1210: 1207: 1205: 1202: 1198: 1195: 1193: 1190: 1188: 1187:SpreadsheetML 1185: 1184: 1183: 1180: 1178: 1175: 1174: 1172: 1170: 1166: 1162: 1155: 1150: 1148: 1143: 1141: 1136: 1135: 1132: 1128: 1122: 1119: 1117: 1114: 1111: 1105: 1100: 1099: 1086: 1080: 1072: 1066: 1058: 1052: 1036: 1032: 1028: 1022: 1006: 1002: 998: 992: 984: 978: 964: 960: 954: 940: 936: 930: 916:on 2016-03-03 915: 911: 905: 903: 887:. 17 May 2024 886: 880: 864: 858: 854: 844: 841: 839: 836: 834: 831: 830: 826: 815: 805: 802: 799: 796: 793: 790: 787: 783: 780: 777: 774: 771: 767: 764: 763: 748: 745: 742: 741: 740: 730: 723: 714: 711: 707: 702: 701: 693: 692: 688: 687: 655: 654: 650: 649: 646: 638: 636: 631: 629: 624: 622: 617: 615: 611: 607: 603: 599: 595: 585: 583: 579: 569: 559: 555: 552: 548: 544: 540: 536: 532: 529: 525: 522: 518: 514: 505: 499: 495: 492: 489: 487: 483: 480: 477: 475: 471: 468: 465: 463: 459: 456: 453: 449: 445: 435: 433: 429: 425: 419: 413: 411: 407: 403: 389: 385: 378: 376: 372: 368: 366: 362: 351: 343: 339: 336: 333: 331: 327: 324: 321: 319: 315: 312: 309: 307: 303: 300: 297: 293: 289: 288:/asciidoc-py3 279: 277: 273: 269: 263: 257: 255: 251: 247: 233: 229: 222: 220: 216: 212: 210: 206: 195: 190: 184: 180: 176: 172: 167: 153: 149: 143: 141: 137: 131: 129: 125: 113: 110: 102: 91: 88: 84: 81: 77: 74: 70: 67: 63: 60: –  59: 55: 54:Find sources: 48: 44: 38: 37: 32:This article 30: 26: 21: 20: 1275: 1264:Lesser-known 1169:Office suite 1126: 1079: 1065: 1051: 1039:. Retrieved 1035:the original 1030: 1021: 1009:. Retrieved 1000: 991: 977: 966:. Retrieved 962: 953: 942:. Retrieved 939:asciidoc.org 938: 929: 918:. Retrieved 914:the original 889:. Retrieved 879: 867:. Retrieved 857: 798:AsciiDocLIVE 738: 722:package-name 721: 718: 709: 703: 699: 698: 644: 632: 626:Most of the 625: 618: 591: 575: 526:, but using 512: 511: 444:/asciidoctor 442:/asciidoctor 415:2.0.23  375:Developer(s) 369:Ryan Waldron 259:10.2.1  219:Developer(s) 105: 96: 86: 79: 72: 65: 53: 41:Please help 36:verification 33: 792:Asciidoc FX 776:AsciiBinder 628:Git project 612:and in the 588:Asciidoctor 535:text editor 502:asciidoctor 359:Asciidoctor 346:asciidoc-py 203:AsciiDoc.py 171:Open format 1493:Categories 1271:AmigaGuide 1218:Well-known 1059:. Git SCM. 1057:"Git wiki" 997:"Asciidoc" 968:2020-03-20 944:2020-03-20 920:2013-10-18 910:"AsciiDoc" 849:References 724:using the 696:My Article 614:JavaScript 528:plain-text 451:Written in 432:Repository 397:2013-01-30 295:Written in 276:Repository 241:2002-11-25 99:March 2014 69:newspapers 58:"AsciiDoc" 1301:CrossMark 782:awestruct 728:command: 706:Knowledge 286:/asciidoc 1454:Wikitext 1404:Org-mode 1399:OpenMath 1389:MusicXML 1366:LinuxDoc 1361:LilyPond 1276:AsciiDoc 1255:Markdown 1005:Archived 833:Markdown 811:See also 735:Hardware 716:Software 700:J. Smith 619:Some of 554:manpages 513:AsciiDoc 187:asciidoc 1444:Texinfo 1341:GuideML 1316:DocBook 1296:ConTeXt 869:21 July 670:copper 641:Example 572:History 558:e-books 531:mark-up 521:DocBook 497:Website 486:License 395: ( 348:.github 341:Website 330:License 239: ( 182:Website 159: ( 83:scholar 1434:Setext 1429:S1000D 1351:HyTime 1291:C-HTML 1281:BBCode 1235:MathML 1041:19 May 891:20 May 786:Jekyll 766:Antora 743:copper 602:GitLab 598:GitHub 438:github 381:et al. 335:GPL v2 299:Python 282:github 225:et al. 85:  78:  71:  64:  56:  1464:WapTV 1449:troff 1394:OMDoc 1331:FHTML 1250:LaTeX 1230:XHTML 1182:OOXML 1011:6 Feb 760:Tools 678:lead 664:`gem` 610:JRuby 515:is a 90:JSTOR 76:books 1469:XAML 1419:RTML 1379:MAML 1370:Lout 1346:HDML 1311:Djot 1306:DITA 1225:HTML 1043:2016 1013:2020 893:2024 871:2024 804:DAPS 749:lead 710:many 674:tin 606:Java 600:and 594:Ruby 566:adoc 551:Unix 539:HTML 504:.org 474:Type 455:Ruby 440:.com 318:Type 284:.com 189:.org 161:2002 154:2002 62:news 1459:WML 1439:TEI 1424:RFT 1409:POD 1384:MEI 1374:MIF 1356:IPF 1336:GML 1321:EAD 1286:CML 1245:TeX 1240:RTF 1209:UOF 1204:ODF 770:git 746:tin 726:gem 562:txt 547:TeX 543:PDF 524:XML 491:MIT 350:.io 177:yes 45:by 1495:: 1029:. 1003:. 999:. 961:. 937:. 901:^ 637:. 592:A 568:. 556:, 549:, 545:, 1153:e 1146:t 1139:v 1087:. 1045:. 1015:. 985:. 971:. 947:. 923:. 895:. 873:. 788:. 772:. 676:* 672:* 668:* 399:) 243:) 173:? 163:) 112:) 106:( 101:) 97:( 87:· 80:· 73:· 66:· 39:.

Index


verification
improve this article
adding citations to reliable sources
"AsciiDoc"
news
newspapers
books
scholar
JSTOR
Learn how and when to remove this message
Filename extensions
Internet media type
Open format
asciidoc.org
Edit this at Wikidata
Original author(s)
Developer(s)
Stable release
Edit this on Wikidata
Repository
github.com/asciidoc/asciidoc-py3
Python
Operating system
Cross-platform
Type
Documentation generator
License
GPL v2
asciidoc-py.github.io

Text is available under the Creative Commons Attribution-ShareAlike License. Additional terms may apply.